Skip to main content

Docuit is a tool which makes sure your README stays up to date and simplifies getting the needed parts out of the README.

Project description

Build Status Dependency Status

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

docuit-0.4.tar.gz (3.4 kB view details)

Uploaded Source

File details

Details for the file docuit-0.4.tar.gz.

File metadata

  • Download URL: docuit-0.4.tar.gz
  • Upload date:
  • Size: 3.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for docuit-0.4.tar.gz
Algorithm Hash digest
SHA256 3aedd3b479cac5f057dd1cf4758e7b5b2923b76d7ce8ac85ef549bde17b1b5a1
MD5 b5bb48a1843d06e18b2582817315b0d1
BLAKE2b-256 ba86cf9ead24590878abb5a162b0d3d3819ff0b7afa0064468be864e31d67525

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page