https://github.com/deathbeds/innit
Configuring a simple python project with docs, blogs, tests, and packaging.
https://github.com/deathbeds/innit
Last synced: 3 months ago
JSON representation
Configuring a simple python project with docs, blogs, tests, and packaging.
- Host: GitHub
- URL: https://github.com/deathbeds/innit
- Owner: deathbeds
- License: bsd-3-clause
- Created: 2020-04-04T04:09:05.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-04-05T00:48:17.000Z (almost 6 years ago)
- Last Synced: 2025-02-02T22:36:41.072Z (11 months ago)
- Language: Python
- Size: 24.4 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# It's easy to configure a python package, `innit`?
import innit
`innit` is a minimal configuration for building and documentating python projects using that shares metadata through the PEP 517 & 518 `"pyproject.toml"` configuration file.
The project is based on `flit` which configures metadata in `"pyproject"`.
`flit` provides a CLI to configure a basic module build. The metadata shares content that needed by `nikola and sphinx` for their configuration. Futhermore, the necessary metadata for a `flit` project would already be provided in a public Github repo.
`innit` configures projects using either a reference to a github repo or with CLI prompts. As much as possible, you should be using Github user interfaces to interact configure projects.
This configuration is ready to be used with Github Actions, Github Pages, and Read the Docs.
## files
* __pyproject.toml__ is configured for the [`flit` configuration][flit configuration].
* __conf.py__ can configure both `nikola and sphinx`. `nikola and sphinx` use the `str.upper and str.lower` namespaces meaning their are no name collisions, and they may be configured simulataneously.
* __setup.py__ runs `setuptools` using the __pyproject.toml__ configuration so that a module can be used in developer module with
```bash
pip install -e .
```
* __index.rst__ provides the table of contents for `sphinx`.
* __LICENSE__ can be created on github.
* __postBuild__ for binder.
## References
* [PEP517]
* [PEP518]
* https://snarky.ca/what-the-heck-is-pyproject-toml/
[flit configuration]: https://flit.readthedocs.io/en/latest/pyproject_toml.html
[binder]: #