| Name | justproj-toolkit JSON |
| Version |
0.1.2
JSON |
| download |
| home_page | None |
| Summary | None |
| upload_time | 2024-10-06 14:01:14 |
| maintainer | None |
| docs_url | None |
| author | alexeev-prog |
| requires_python | <4.0,>=3.12 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# JustProj
<p align="center">A toolkit for creating documentation and project management diagrams in Python</p>
<br>
<p align="center">
<img src="https://img.shields.io/github/languages/top/alexeev-prog/JustProj?style=for-the-badge">
<img src="https://img.shields.io/github/languages/count/alexeev-prog/JustProj?style=for-the-badge">
<img src="https://img.shields.io/github/license/alexeev-prog/JustProj?style=for-the-badge">
<img src="https://img.shields.io/github/stars/alexeev-prog/JustProj?style=for-the-badge">
<img src="https://img.shields.io/github/issues/alexeev-prog/JustProj?style=for-the-badge">
<img src="https://img.shields.io/github/last-commit/alexeev-prog/JustProj?style=for-the-badge">
</p>
> [!CAUTION]
> At the moment, JustProj is under active development (alpha), many things may not work, and this version is not recommended for use (all at your own risk).
## Installion
```bash
pip3 install justproj_toolkit
```
Run example:
```bash
python3 -m justproj_toolkit
```
## Example
```python
from justproj_toolkit.baseproject.documentation import InitiationSection, DocumentSubsection, DocumentFolder, ProjectManager, ProjectTemplate
s1 = InitiationSection('Introduction', 'An introduction to JustProj Toolkit', {'Language': 'Python with some libs'})
s2 = InitiationSection('Introduction 2', 'An another introduction number 2 to JustProj Toolkit', {'Number': 'version 2'})
ss1 = DocumentSubsection('InitiationSubSection', {'Test2': 'hi'}, s1)
ss2 = DocumentSubsection('InitiationSubSection 2', {'Test3': 'hi wpr;d'}, s2)
s1.link_new_subsection(ss1)
s2.link_new_subsection(ss2)
folder = DocumentFolder('basic', 'app/docs', [s1, s2])
project_manager = ProjectManager('JustProj Toolkit', 'An another tool for project management and creation', 'Bla-bla-bla',
'alexeev-prog', 'JustProj', 'app',
ProjectTemplate.CPP, [folder], [s1, s2])
project_manager.add_directory_to_structure('examples', ['example-1.txt', 'example-2.txt'])
project_manager.process_project()
```
Raw data
{
"_id": null,
"home_page": null,
"name": "justproj-toolkit",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.12",
"maintainer_email": null,
"keywords": null,
"author": "alexeev-prog",
"author_email": "dev.alexeev@mail.ru",
"download_url": "https://files.pythonhosted.org/packages/3e/8c/d4bb8668ed5dff07d853000f97e9790947e733cbfc7514b29e798c8d2f32/justproj_toolkit-0.1.2.tar.gz",
"platform": null,
"description": "# JustProj\n\n<p align=\"center\">A toolkit for creating documentation and project management diagrams in Python</p>\n<br>\n<p align=\"center\">\n\t<img src=\"https://img.shields.io/github/languages/top/alexeev-prog/JustProj?style=for-the-badge\">\n\t<img src=\"https://img.shields.io/github/languages/count/alexeev-prog/JustProj?style=for-the-badge\">\n\t<img src=\"https://img.shields.io/github/license/alexeev-prog/JustProj?style=for-the-badge\">\n\t<img src=\"https://img.shields.io/github/stars/alexeev-prog/JustProj?style=for-the-badge\">\n\t<img src=\"https://img.shields.io/github/issues/alexeev-prog/JustProj?style=for-the-badge\">\n\t<img src=\"https://img.shields.io/github/last-commit/alexeev-prog/JustProj?style=for-the-badge\">\n</p>\n\n> [!CAUTION]\n> At the moment, JustProj is under active development (alpha), many things may not work, and this version is not recommended for use (all at your own risk).\n\n## Installion\n\n```bash\npip3 install justproj_toolkit\n```\n\nRun example:\n\n```bash\npython3 -m justproj_toolkit\n```\n\n## Example\n\n```python\nfrom justproj_toolkit.baseproject.documentation import InitiationSection, DocumentSubsection, DocumentFolder, ProjectManager, ProjectTemplate\n\ns1 = InitiationSection('Introduction', 'An introduction to JustProj Toolkit', {'Language': 'Python with some libs'})\ns2 = InitiationSection('Introduction 2', 'An another introduction number 2 to JustProj Toolkit', {'Number': 'version 2'})\nss1 = DocumentSubsection('InitiationSubSection', {'Test2': 'hi'}, s1)\nss2 = DocumentSubsection('InitiationSubSection 2', {'Test3': 'hi wpr;d'}, s2)\ns1.link_new_subsection(ss1)\ns2.link_new_subsection(ss2)\n\nfolder = DocumentFolder('basic', 'app/docs', [s1, s2])\n\nproject_manager = ProjectManager('JustProj Toolkit', 'An another tool for project management and creation', 'Bla-bla-bla', \n\t\t\t\t\t\t\t'alexeev-prog', 'JustProj', 'app',\n\t\t\t\t\t\t\tProjectTemplate.CPP, [folder], [s1, s2])\n\nproject_manager.add_directory_to_structure('examples', ['example-1.txt', 'example-2.txt'])\n\nproject_manager.process_project()\n\n```\n",
"bugtrack_url": null,
"license": null,
"summary": null,
"version": "0.1.2",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "35a2481e425edbe2e5a4ed2d80bf93234aa4222bb6b85856c6fd2f03b6d4a640",
"md5": "742ba6a9a4b2e228d6202fc8b7cffb70",
"sha256": "71afe2470f058f9eea9a4236cc5cb8bdbe064c5aec08cdf2dcad810bdf30ade6"
},
"downloads": -1,
"filename": "justproj_toolkit-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "742ba6a9a4b2e228d6202fc8b7cffb70",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.12",
"size": 5912,
"upload_time": "2024-10-06T14:01:12",
"upload_time_iso_8601": "2024-10-06T14:01:12.326015Z",
"url": "https://files.pythonhosted.org/packages/35/a2/481e425edbe2e5a4ed2d80bf93234aa4222bb6b85856c6fd2f03b6d4a640/justproj_toolkit-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3e8cd4bb8668ed5dff07d853000f97e9790947e733cbfc7514b29e798c8d2f32",
"md5": "a8dab98be7c5c9aec682e3267eb69416",
"sha256": "4106a699f6f833109f01ce508093e2378d5268fa03cb21452c0bda3f73d987cb"
},
"downloads": -1,
"filename": "justproj_toolkit-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "a8dab98be7c5c9aec682e3267eb69416",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.12",
"size": 4586,
"upload_time": "2024-10-06T14:01:14",
"upload_time_iso_8601": "2024-10-06T14:01:14.354973Z",
"url": "https://files.pythonhosted.org/packages/3e/8c/d4bb8668ed5dff07d853000f97e9790947e733cbfc7514b29e798c8d2f32/justproj_toolkit-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-06 14:01:14",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "justproj-toolkit"
}
