Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updated installing instructions to use pip #5273

Merged
merged 2 commits into from
Apr 24, 2023

Conversation

tkknight
Copy link
Contributor

@tkknight tkknight commented Apr 24, 2023

🚀 Pull Request

Description

Updated the installing instructions to use:

pip install --no-deps --editable .

instead of:

python setup.py develop

Using pip is considered better practice, also the old way shows a couple of strong warnings:

/home/theuser/projects/iris
$ python setup.py develop
/home/theuser/.conda/envs/iris-dev/lib/python3.11/site-packages/setuptools/config/pyprojecttoml.py:66: _BetaConfiguration: Support for [tool.setuptools] in pyproject.toml is still *beta*.
  config = read_configuration(filepath, True, ignore_option_errors, dist)
running develop
/home/theuser/.conda/envs/iris-dev/lib/python3.11/site-packages/setuptools/command/develop.py:40: EasyInstallDeprecationWarning: easy_install command is deprecated.
!!

        ********************************************************************************
        Please avoid running ``setup.py`` and ``easy_install``.
        Instead, use pypa/build, pypa/installer, pypa/build or
        other standards-based tools.

        See https://github.com/pypa/setuptools/issues/917 for details.
        ********************************************************************************

!!
  easy_install.initialize_options(self)
/home/theuser/.conda/envs/iris-dev/lib/python3.11/site-packages/setuptools/_distutils/cmd.py:66: SetuptoolsDeprecationWarning: setup.py install is deprecated.
!!

        ********************************************************************************
        Please avoid running ``setup.py`` directly.
        Instead, use pypa/build, pypa/installer, pypa/build or
        other standards-based tools.

        See https://blog.ganssle.io/articles/2021/10/setup-py-deprecated.html for details.
        ********************************************************************************

!!
  self.initialize_options()
running egg_info
writing lib/scitools_iris.egg-info/PKG-INFO
writing dependency_links to lib/scitools_iris.egg-info/dependency_links.txt
writing requirements to lib/scitools_iris.egg-info/requires.txt
writing top-level names to lib/scitools_iris.egg-info/top_level.txt
reading manifest template 'MANIFEST.in'
<SNIP>

Consult Iris pull request check list

@codecov
Copy link

codecov bot commented Apr 24, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (6cecf04) 89.32% compared to head (58fa0dd) 89.32%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #5273   +/-   ##
=======================================
  Coverage   89.32%   89.32%           
=======================================
  Files          89       89           
  Lines       22390    22390           
  Branches     5374     5374           
=======================================
  Hits        20000    20000           
  Misses       1640     1640           
  Partials      750      750           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

Copy link
Contributor

@trexfeathers trexfeathers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @tkknight! Is there more to do on this (still in Draft)?

@tkknight tkknight marked this pull request as ready for review April 24, 2023 11:28
@bjlittle bjlittle self-assigned this Apr 24, 2023
@bjlittle bjlittle self-requested a review April 24, 2023 11:52
Copy link
Member

@bjlittle bjlittle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tkknight Lovely change 👍

Thanks for showing the docs and its infrastructure so much attention 💯

@bjlittle bjlittle merged commit 1afae0d into SciTools:main Apr 24, 2023
tkknight added a commit to tkknight/iris that referenced this pull request Apr 24, 2023
* upstream/main:
  updated installing instructions to use pip (SciTools#5273)
  remove sphinx-panel config as now longer needed (SciTools#5272)
tkknight added a commit to tkknight/iris that referenced this pull request Apr 25, 2023
* upstream/main:
  Two negating pins for dependencies - libnetcdf and numpy (SciTools#5274)
  [pre-commit.ci] pre-commit autoupdate (SciTools#5275)
  updated installing instructions to use pip (SciTools#5273)
  remove sphinx-panel config as now longer needed (SciTools#5272)
@tkknight tkknight deleted the update_install_docs branch November 9, 2023 15:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants