Skip to content

Commit

Permalink
NASA-AMMOS/slim#46: Reorganized setup.cfg to condense all user moddif…
Browse files Browse the repository at this point in the history
…iable fields. Updated README to simplify install command. ...
  • Loading branch information
jpl-jengelke committed Jan 6, 2023
1 parent f45ade4 commit ead3b6d
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 21 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ rm -r build dist __pycache__ *.egg* .egg* ; git checkout [INSERT YOUR PACKAGE NA
2. Build and install release locally:
```
python3 -m build --wheel && python3 setup.py sdist --format=zip
pip3 install [INSERT YOUR PACKAGE NAME] --no-index --find-links file://<local_path_to_repo>/dist/
pip3 install [INSERT YOUR PACKAGE NAME] --no-index --find-links file://${PWD}/dist/
```
... alternately, install an editable build using [Pip tooling](https://pypi.org/project/pip/) ...
```
Expand Down
38 changes: 18 additions & 20 deletions setup.cfg
Original file line number Diff line number Diff line change
@@ -1,6 +1,23 @@
[metadata]
[options]
zip_safe = False
python_requires = >=3.9
include_package_data = True
packages = find:
install_requires = file: requirements.txt

[options.packages.find]
exclude =
tests
*.tests
*.tests.*
tests.*

# [MODIFY FOR YOUR PROJECT] ###################################################
[options.entry_points]
console_scripts =
slim-sample-project = slim_sample_project.hello_world:main

[metadata]
name = slim_sample_project
url = https://github.com/NASA-AMMOS/slim-starterkit-python
download_url = https://github.com/NASA-AMMOS/slim-starterkit-python/releases/latest
Expand Down Expand Up @@ -36,22 +53,3 @@ license_files =
LICENSE
long_description = file: README.md
long_description_content_type = text/markdown; charset=UTF-8
[options]
zip_safe = False
python_requires = >=3.9
include_package_data = True
packages = find:
install_requires = file: requirements.txt
[options.entry_points]
console_scripts =
# [MODIFY FOR YOUR PROJECT]
slim-sample-project = slim_sample_project.hello_world:main
[options.packages.find]
exclude =
tests
*.tests
*.tests.*
tests.*

0 comments on commit ead3b6d

Please sign in to comment.