Docuit
Docuit is a tool which makes sure your README stays up to date and simplifies getting the needed parts out of the README.
When working with multiple repositories, maybe different languages, the steps to build, test, run and deploy needs to be fetched to use the source. In good cases with a proper documentation it is sometimes tedious to find that over and over again.
Docuit parses the README for the needed part prints them out ord can execute the steps right away.
docuit check to make sure all necessary parts exist and prints out what is missing.
docuit build|test|run|deploy Prints the content of the section.
--exec flag will execute the steps.
Using docuit makes sure all repositories have a similar README structure, simplifies using of the code and with the right setup can also simplify the continues deploy process: docuit deploy --exec.
Build
pip install -r requirements.txt
Test
flake8 *.py
Run
docuit
Deploy
python setup.py sdist upload
1 maintainer
Metadata
1 maintainer
Release files for docuit 0.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| docuit-0.4.tar.gz | 3.4 kB | Without provenance | Details for docuit-0.4.tar.gz |
Release files / docuit-0.4.tar.gz
| Download URL | docuit-0.4.tar.gz |
|---|---|
| Size | 3.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3aedd3b479cac5f057dd1cf4758e7b5b2923b76d7ce8ac85ef549bde17b1b5a1
|
|
BLAKE2b-256 checksum How to use checksums |
ba86cf9ead24590878abb5a162b0d3d3819ff0b7afa0064468be864e31d67525
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for docuit 0.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
