Cleanup requirements a little and remove setup.cfg file. #64
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mithro
force-pushed
the
setupcfg
branch
13 times, most recently
from
de4f839
to
3942eca
Compare
litghost
reviewed
Feb 22, 2021
| requires = ["setuptools", "wheel", "cython"] | ||
| requires = [ | ||
| "cython", | ||
| "setuptools>=42", |
There was a problem hiding this comment.
Worth adding a comment on why >=42?
litghost
reviewed
Feb 22, 2021
| entry_points={ | ||
| 'console_scripts': ['fasm=fasm.tool:main'], | ||
| }, | ||
| # Requirements | ||
| python_requires=">=3.6", | ||
| setup_requires=[ # WARNING: Must be kept in sync with pyproject.toml |
There was a problem hiding this comment.
I think setup_requires is deprecated really, because of chicken/egg problem.
mithro
force-pushed
the
setupcfg
branch
14 times, most recently
from
b1bfb1d
to
2137848
Compare
mithro
force-pushed
the
setupcfg
branch
6 times, most recently
from
dfba517
to
0791037
Compare
|
setup.py is not recommended. While pyproject.toml is preferred to setup.cfg, setup.cfg is still preferred to setup.py: |
mithro
force-pushed
the
setupcfg
branch
7 times, most recently
from
634e5c7
to
1c65229
Compare
Signed-off-by: Tim 'mithro' Ansell <[email protected]>
`setup_requires` needs to be specified in *both* `setup.py` and `pyproject.toml`. The `requirements.txt` file should use `-e .` to install the module (and thus get the requirements). If a local or non-PyPi version of a module should be used to satisfy a requirement for either `setup_requires` or `install_requires` then it should also be specified in the `requirements.txt` file. Using `setup.py` is much clearer than `setup.cfg` and it looks like the file is going to get replaced by `pyproject.toml` in the future, see pypa/setuptools#1688 The generated Cython C file is included in the source distribution, so only people building from the git repository need to have Cython installed (fixing import issue). Signed-off-by: Tim 'mithro' Ansell <[email protected]>
Signed-off-by: Tim 'mithro' Ansell <[email protected]>
Signed-off-by: Tim 'mithro' Ansell <[email protected]>
Signed-off-by: Tim 'mithro' Ansell <[email protected]>
Steps are; 1) Get Python + PIP. 2) Run `update_version.py` 3) Install package's system dependencies. 4) Install package. Signed-off-by: Tim 'mithro' Ansell <[email protected]>
* Create a composite action for setting up the system.
* Expand `check-install.yml` to check that installing works from all
of;
- GitHub
- Checked out locally with `python setup.py install`
- Checked out locally with `pip install -e .`
- Building and then installing wheels.
* Remove `wheel.yml` as covered by `check-install.yml`'s building and
then installing wheels.
Signed-off-by: Tim 'mithro' Ansell <[email protected]>
- Use the new mithro/actions-includes for common functionality. - Refactor common functionality into their own include actions. Signed-off-by: Tim 'mithro' Ansell <[email protected]>
mithro
force-pushed
the
setupcfg
branch
4 times, most recently
from
6104e2a
to
066abb3
Compare
Signed-off-by: Tim 'mithro' Ansell <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
setup_requiresneeds to be specified in bothsetup.pyandpyproject.toml.The
requirements.txtfile should use-e .to install the module (and thus get the requirements). If a local or non-PyPi version of a module should be used to satisfy a requirement for eithersetup_requiresorinstall_requiresthen it should also be specified in therequirements.txtfile.Using
setup.pyis much clearer thansetup.cfgand it looks like the file is going to get replaced bypyproject.tomlin the future, see pypa/setuptools#1688Signed-off-by: Tim 'mithro' Ansell [email protected]