Skip to content

Commit

Permalink
update contribution guide to reflect usage of pyproject.toml. Fix a f…
Browse files Browse the repository at this point in the history
…ew minor grammatical errors
  • Loading branch information
aaraney authored and AustinRaney-NOAA committed Mar 31, 2021
1 parent 320a328 commit 062bc63
Showing 1 changed file with 17 additions and 3 deletions.
20 changes: 17 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,10 +109,11 @@ python
│ └── foo.py
│ └── bar.py
├── setup.py
├── pyproject.toml
└── tests/
```

3. The packages `setup.py` should use the following template:
3. The package's `setup.py` should use the following template:

```python
#!/usr/bin/env python3
Expand Down Expand Up @@ -157,7 +158,20 @@ setup(
)
```

4. The _package_ level (not subpackage) `setup.py` dictionary `SUBPACKAGES`
4. The package's `pyproject.toml` should use the following template and add any
build-system requirements:

```
[build-system]
build-backend = "setuptools.build_meta"
requires = [
"setuptools>=42",
"wheel",
]
```

5. The _package_ level (not subpackage) `setup.py` dictionary `SUBPACKAGES`
should be updated to include the subpackage slug (i.e.
`evaluation_tools.my_subpackage`) and the relative path to the subpackage
(i.e. `python/my_subpackage`).
Expand All @@ -172,4 +186,4 @@ SUBPACKAGES ={
}
```

Further explanation of the rational behind this pattern and more verbose explanation can be found in #12.
Further explanation of the rational behind this pattern and more verbose explanation can be found in #12.

0 comments on commit 062bc63

Please sign in to comment.