| Name | py-chronicler JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | https://github.com/jasuca/chronicler |
| Summary | Chronicler is a Python tool that automates documentation in development projects. Utilizing Git and language processing technologies, it offers an intuitive interface for tracking changes and generating detailed documentation, seamlessly integrating with version control workflows. It's perfect for developers and teams aiming to boost productivity and maintain clear, current project documentation, thereby simplifying project management. |
| upload_time | 2024-01-29 15:29:36 |
| maintainer | |
| docs_url | None |
| author | Jacob Sunol |
| requires_python | >=3.6, <4 |
| license | |
| keywords |
development
automation
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Chronicler
Chronicler is an innovative Python tool designed to streamline and automate the documentation process for development projects. Leveraging the power of Git and various language processing technologies, it provides an intuitive interface for tracking changes, generating comprehensive documentation, and ensuring seamless integration with existing version control workflows. Ideal for developers and teams looking to enhance their productivity and maintain clear, up-to-date documentation, Chronicler simplifies the complexities of project management and documentation.
## Getting Started
### Prerequisites
- Python 3.6 or higher
- Git
### Installation
Clone the repository:
```bash
git clone https://github.com/jasuca/chronicler.git
cd chronicler
```
Set up a virtual environment:
```bash
python -m venv venv
source venv/bin/activate # On Windows use 'venv\Scripts\activate'
```
Install the package in editable mode:
```bash
pip install --editable .
```
This command will install the package and its dependencies, allowing you to make changes to the code and see them reflected immediately.
### Running Locally
With the virtual environment activated and the package installed in editable mode, you can run Chronicler directly from the command line:
```bash
chronicler
```
## Contributing
We welcome contributions to the Chronicler project! If you have suggestions for improvements or want to contribute code, please follow these steps:
1. Fork the repository.
2. Create a new branch (`git checkout -b feature-branch`).
3. Make your changes and commit them (`git commit -am 'Add some feature'`).
4. Push to the branch (`git push origin feature-branch`).
5. Create a new Pull Request.
## License
This project is licensed under the MIT License - see the LICENSE file for details.
Raw data
{
"_id": null,
"home_page": "https://github.com/jasuca/chronicler",
"name": "py-chronicler",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6, <4",
"maintainer_email": "",
"keywords": "development,automation",
"author": "Jacob Sunol",
"author_email": "contact@jasuca.com",
"download_url": "https://files.pythonhosted.org/packages/01/7a/1aec3658ddef2f8e6fc8748bd55123bea5bff3a01033c166fa9ff4773835/py-chronicler-0.1.0.tar.gz",
"platform": null,
"description": "\n# Chronicler\n\nChronicler is an innovative Python tool designed to streamline and automate the documentation process for development projects. Leveraging the power of Git and various language processing technologies, it provides an intuitive interface for tracking changes, generating comprehensive documentation, and ensuring seamless integration with existing version control workflows. Ideal for developers and teams looking to enhance their productivity and maintain clear, up-to-date documentation, Chronicler simplifies the complexities of project management and documentation.\n\n## Getting Started\n\n### Prerequisites\n\n- Python 3.6 or higher\n- Git\n\n### Installation\n\nClone the repository:\n\n```bash\ngit clone https://github.com/jasuca/chronicler.git\ncd chronicler\n```\n\nSet up a virtual environment:\n\n```bash\npython -m venv venv\nsource venv/bin/activate # On Windows use 'venv\\Scripts\\activate'\n```\n\nInstall the package in editable mode:\n\n```bash\npip install --editable .\n```\n\nThis command will install the package and its dependencies, allowing you to make changes to the code and see them reflected immediately.\n\n### Running Locally\n\nWith the virtual environment activated and the package installed in editable mode, you can run Chronicler directly from the command line:\n\n```bash\nchronicler\n```\n\n## Contributing\n\nWe welcome contributions to the Chronicler project! If you have suggestions for improvements or want to contribute code, please follow these steps:\n\n1. Fork the repository.\n2. Create a new branch (`git checkout -b feature-branch`).\n3. Make your changes and commit them (`git commit -am 'Add some feature'`).\n4. Push to the branch (`git push origin feature-branch`).\n5. Create a new Pull Request.\n\n## License\n\nThis project is licensed under the MIT License - see the LICENSE file for details.\n",
"bugtrack_url": null,
"license": "",
"summary": "Chronicler is a Python tool that automates documentation in development projects. Utilizing Git and language processing technologies, it offers an intuitive interface for tracking changes and generating detailed documentation, seamlessly integrating with version control workflows. It's perfect for developers and teams aiming to boost productivity and maintain clear, current project documentation, thereby simplifying project management.",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/jasuca/chronicler"
},
"split_keywords": [
"development",
"automation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bc05e2af5f9d9ce8660dfad05d10e9a4f4603072a5bb4dd711e174ec7de82136",
"md5": "d1a6f71be87af00b530c5cc1e249f8b6",
"sha256": "250a416035cadea1bf580b46b0daab3c733d1d764e1366cb82d64c9b8b422fe0"
},
"downloads": -1,
"filename": "py_chronicler-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d1a6f71be87af00b530c5cc1e249f8b6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6, <4",
"size": 3372,
"upload_time": "2024-01-29T15:29:34",
"upload_time_iso_8601": "2024-01-29T15:29:34.724924Z",
"url": "https://files.pythonhosted.org/packages/bc/05/e2af5f9d9ce8660dfad05d10e9a4f4603072a5bb4dd711e174ec7de82136/py_chronicler-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "017a1aec3658ddef2f8e6fc8748bd55123bea5bff3a01033c166fa9ff4773835",
"md5": "24237576a9ae83655b9e658686e40224",
"sha256": "af82c7d54677907bce5037324bee8dff5365474f9dbd1e164aec7feb9b615ad3"
},
"downloads": -1,
"filename": "py-chronicler-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "24237576a9ae83655b9e658686e40224",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6, <4",
"size": 3432,
"upload_time": "2024-01-29T15:29:36",
"upload_time_iso_8601": "2024-01-29T15:29:36.741845Z",
"url": "https://files.pythonhosted.org/packages/01/7a/1aec3658ddef2f8e6fc8748bd55123bea5bff3a01033c166fa9ff4773835/py-chronicler-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-29 15:29:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jasuca",
"github_project": "chronicler",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "py-chronicler"
}
