Skip to content

Make PEP-621 compliant #19

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

Merged
merged 3 commits into from
Apr 21, 2021
Merged

Make PEP-621 compliant #19

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3d68cf3
Make PEP-621 compliant
TheCleric Apr 21, 2021
c09af9f
Update documentation
TheCleric Apr 21, 2021
a9260e3
Re-license as MIT
TheCleric Apr 21, 2021
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
Prev Previous commit
Next Next commit
Update documentation
  • Loading branch information
@TheCleric
TheCleric committed Apr 21, 2021
commit c09af9f523dc72b598fba4e5042b51a4e235c082
22 changes: 7 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ in the `requires` list.

Replace setuptools import in your `setup.py` with an import of ppsetuptools.
ppsetuptools exposes all functions from setuptools, and in addition will map
your `pyproject.toml` data to the call to `setuptools.setup` for you.
your `pyproject.toml` data to the call to `setuptools.setup` for you (via
PEP-621 compliant entries).

### Example `pyproject.toml`

Expand All @@ -22,7 +23,7 @@ your `pyproject.toml` data to the call to `setuptools.setup` for you.
name = 'my_package'
project_name = 'my_package'
version = '1.0.0'
long_description = 'file: README.md'
readme = 'README.md'
install_requires = [
'setuptools',
'toml'
Expand All @@ -46,20 +47,16 @@ from ppsetuptools import setup
setup()
```

### File references

ppsetuptools will attempt to replace any strings beginning with "file:" with the
file's contents. For the long_description entry, ppsetuptools will also attempt
to fill long_description_content_type for you based on the filename.

### File locations

As of now, the library attempts to find a `pyproject.toml` file in the same
directory as the python file that called it. So if calling directly from
`setup.py`, ensure that your `pyproject.toml` file is in the same directory.

As well any file references will attempt to be followed from this location.
E.g., if including a `file: README.md` reference, ppsetuptools will look for
As well any file references (such as the `readme`) will attempt to be followed
from this location.

E.g., if including a `redme = 'README.md'` value, ppsetuptools will look for
`README.md` in the same directory as the file that called it.

### Function support
Expand All @@ -77,8 +74,3 @@ setup(
find_packages(exclude=['tests'])
)
```

## PEP 621

NOTE: This is not currently PEP 621 as that PEP is still in draft status. This
project will be made PEP 621 compliant in the future if the PEP is accepted.