Skip to main content

Unified enterprise documentation suite for Dhruv13x organization — providing policy, compliance, and automation templates for enterprise-grade Python projects.

Project description

enterprise-docs logo

🧱 Enterprise Docs

A unified collection of professional, enterprise-grade documentation templates for your projects — enabling consistent governance, security, and compliance across all repositories.

PyPI version Python Wheel Release

Build status Codecov Test Coverage Code style: black Ruff Security

Downloads OS Python Versions

License: MIT

Docs

About

enterprise-docs is a command-line tool that provides a comprehensive suite of professional, enterprise-grade documentation templates. It helps organizations and open-source projects maintain consistency, enforce standards, and streamline compliance across all their repositories. With a single command, you can sync everything from CODE_OF_CONDUCT.md to a SECURITY_RESPONSE_PLAYBOOK.md.


🚀 Quick Start

Prerequisites

  • Python 3.10+

Installation

pip install enterprise-docs

Usage Example

To see a list of all available documentation templates, run:

enterprise-docs list

To sync all the templates to a local ./docs directory, run:

enterprise-docs sync --to ./docs

✨ Key Features

  • God Level Template Library: Access over 30 professional templates, including SECURITY.md, GOVERNANCE.md, and CHANGELOG.md.
  • Single Source of Truth: Standardize documentation across all your projects to ensure consistency and compliance.
  • Effortless Synchronization: A simple and intuitive CLI lets you sync all templates with a single command.
  • Automation-Friendly: Designed to be easily integrated into your CI/CD pipelines, keeping your documentation perpetually up-to-date.
  • Fully Extensible: While enterprise-docs provides a robust set of templates, you can easily add your own to the collection.

⚙️ Configuration & Advanced Usage

CLI Arguments

The enterprise-docs CLI offers the following commands and options:

Command Description
list Lists all available documentation templates.
sync Copies all templates to a specified directory.
version Displays the installed version of the package.
Option Default Description
--to ./docs The destination directory for the sync command.

🏗️ Architecture

The project is structured as follows:

.
├── src
│   └── enterprise_docs
│       ├── templates
│       │   ├── ARCHITECTURE.md
│       │   ├── ... (and 30+ other templates)
│       │   └── default_pyproject.toml
│       ├── __init__.py
│       ├── banner.py
│       └── cli.py
├── tests
│   └── ...
└── pyproject.toml

The core logic is contained in cli.py, which parses the command-line arguments and calls the appropriate functions. The templates directory contains all the markdown files that are copied by the sync command.


🗺️ Roadmap

For a detailed view of our future plans, please see the ROADMAP.md file.


🤝 Contributing & License

Contributions are welcome! Please see the CONTRIBUTING.md file for more details.

This project is licensed under the MIT License. See the LICENSE file for more details.

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

enterprise_docs-3.0.3.tar.gz (939.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

enterprise_docs-3.0.3-py3-none-any.whl (68.2 kB view details)

Uploaded Python 3

File details

Details for the file enterprise_docs-3.0.3.tar.gz.

File metadata

  • Download URL: enterprise_docs-3.0.3.tar.gz
  • Upload date:
  • Size: 939.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for enterprise_docs-3.0.3.tar.gz
Algorithm Hash digest
SHA256 ae96dd31a0e806432fba36554f9095fefe931ef4f29adf34a33cb1e726b81655
MD5 01f373229395b64af5fce15b53031881
BLAKE2b-256 145290d4b045819b7635ba085ef31bd5092c660564d17333bb9b3510edd2c7ef

See more details on using hashes here.

Provenance

The following attestation bundles were made for enterprise_docs-3.0.3.tar.gz:

Publisher: publish.yml on dhruv13x/enterprise-docs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file enterprise_docs-3.0.3-py3-none-any.whl.

File metadata

File hashes

Hashes for enterprise_docs-3.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 c3b72a9bbb5577a42c78c3477ab28da5db4a28d00a8238bc332effb6c7553e45
MD5 2171e8278a81e796f5e6dec769a9397e
BLAKE2b-256 17b21992b8505c58b9a302ba08a2c36fd5e9e2bc8656096aa04966f41341be3c

See more details on using hashes here.

Provenance

The following attestation bundles were made for enterprise_docs-3.0.3-py3-none-any.whl:

Publisher: publish.yml on dhruv13x/enterprise-docs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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