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.

Sign up for GitHub

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

Migrate setup.py references to pyproject.toml. #182

Merged
merged 1 commit into from
Mar 14, 2023
Merged

Migrate setup.py references to pyproject.toml. #182

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ All contributors must agree to the Contributor Agreement ([ContributorAgreement.
* Use the [OneFlow](https://www.endoflineblog.com/oneflow-a-git-branching-model-and-workflow) model of development:
- Both new features and bug fixes should be developed in branches based on `master`.
- Hotfixes (critical bugs that need to be released *fast*) should be developed in a branch based on the latest tagged release.
* Write code that is compatible with all supported versions of Python (listed in [setup.py](https://github.com/glotzerlab/signac/blob/master/setup.py)).
* Write code that is compatible with all supported versions of Python (listed in [pyproject.toml](https://github.com/glotzerlab/signac/blob/master/pyproject.toml)).
* Avoid introducing dependencies -- especially those that might be harder to install in high-performance computing environments.
* Create [unit tests](https://en.wikipedia.org/wiki/Unit_testing) and [integration tests](https://en.wikipedia.org/wiki/Integration_testing) that cover the common cases and the corner cases of the code.
* Preserve backwards-compatibility whenever possible, and make clear if something must change.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/community.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ All code contributed via pull request needs to adhere to the following guideline
- Both new features and bug fixes should be developed in branches based on ``master``.
- Hotfixes (critical bugs that need to be released *fast*) should be developed in a branch based on the latest tagged release.

* Write code that is compatible with all supported versions of Python (listed in the package ``setup.py`` file).
* Write code that is compatible with all supported versions of Python (listed in the package ``pyproject.toml`` file).
* Avoid introducing dependencies -- especially those that might be harder to install in high-performance computing environments.
* All code needs to adhere to the PEP8_ style guide, with the exception that a line may have up to 100 characters.
* Create `unit tests <https://en.wikipedia.org/wiki/Unit_testing>`_ and `integration tests <ttps://en.wikipedia.org/wiki/Integration_testing>`_ that cover the common cases and the corner cases of the code.
Expand Down
10 changes: 5 additions & 5 deletions docs/source/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,18 +47,18 @@ For a standard installation with pip_, execute:
Installation from Source
========================

Alternatively, you can clone any of the package's source code repositories and install them manually.
Alternatively, you can clone any of the packages' source code repositories and install them manually.
For example, to install the signac core package you can execute the following code:

.. code:: bash

# Option 1
git clone https://github.com/glotzerlab/signac.git
cd signac
python setup.py install --user
pip install .
Copy link
Collaborator

Choose a reason for hiding this comment

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

The --user flag works in pip, but are we assuming most are using virtual environments these days so the flag isn't needed?

Copy link
Member Author

Choose a reason for hiding this comment

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

I’m just matching what we wrote in signac’s own package docs. Yes, I think that we are assuming users are in a virtual environment and/or know how to add that flag if needed.

Copy link
Member

Choose a reason for hiding this comment

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

The vast majority of users copy and paste given instructions. I agree with removing --user as it is more likely to cause problems for users (i.e. when they update their Python version or use another Python installation with the same version).


.. note::

If you want to install packages for all users on a machine, you can remove the ``--user`` option in the install command.
# Option 2
pip install git+https://github.com/glotzerlab/signac.git


Build Status
Expand Down