doc-agent
A simple command line interface to run a workflow defined in a YAML file.
Installation
You can install doc-agent via pip:
To install doc-agent, run this command in your terminal .. code-block:: bash
$ pip install doc-agent
If you don’t have pip installed, this Python installation guide can guide you through the process.
Usage
After installing doc-agent, you can use it from the command line. Here are some examples:
$ doc-agent --helpQuickstart
To use doc-agent, you need to create a YAML file with the workflow you want to run. Here is an example:
Generate a example workflow file:
$ doc-agent generateTest the workflow:
$ doc-agent test workflow.ymlRun the workflow:
$ doc-agent run workflow.yml1 maintainer
Metadata
1 maintainer
Release files for doc-agent 0.0.1
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 | |
|---|---|---|---|---|
| doc_agent-0.0.1.tar.gz | 41.7 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| doc_agent-0.0.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 67.9 kB
Release files / doc_agent-0.0.1.tar.gz
| Download URL | doc_agent-0.0.1.tar.gz |
|---|---|
| Size | 41.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
64433c07fd17cc43b256b43a9f02bdb2263a3acb73de24358d6415a4f4779d7f
|
|
BLAKE2b-256 checksum How to use checksums |
bf58ec413823926bb4d058b3c12a45bfdecfd74f93117b2223070f9e03659122
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.8
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Feb 16, 2025.
Transparency logRelease files / doc_agent-0.0.1-py3-none-any.whl
| Download URL | doc_agent-0.0.1-py3-none-any.whl |
|---|---|
| Size | 26.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1322626115288fb084f12a2d8b7daf8b8138c93a40cb94cc91a7ea80f600b8b1
|
|
BLAKE2b-256 checksum How to use checksums |
59484171d0ba3676aa9ffe4f68b3f260dca110e2933971c513b22bd7c86505e0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.8
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Feb 16, 2025.
Transparency logSecurity for doc-agent 0.0.1
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.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for doc_agent-0.0.1.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Feb 16, 2025.
Transparency logA 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.
