| Name | docman JSON |
| Version |
0.0.6
JSON |
| download |
| home_page | None |
| Summary | Document Manager |
| upload_time | 2024-08-13 12:46:24 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | Copyright © 2024 David <c0d3@gpobox.net> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
documents
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
pytest
pytest-cov
coverage
wheel
build
twine
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# DocMan - Document Manager
DocMan is a simple text based document manager.
It currently has zero dependencies on other packages.
## Be aware
If you think this is a normal file manager you will be disappointed.
It is designed as a recursive document manager based on files and links.
It provides the appearance of a hierarchy while having a shallow directory tree.
This is so that multiple associations can easily be created to the same folder.
A database contains folders and files.
A folder can contain references to other folders.
A folder can contain files.
All folders are stored in the **Database/** directory on the file system as a directory per folder.
All references to folders are created as symbolic links in the directory.
All files in the folder are stored in the directory for the folder.
A database does not support creating references to files.
## Commands
The following commands are supported:
MENU
LIST
LIST LIKE <pattern>...
LIST LINKS
LIST LINKS LIKE <pattern>...
LIST AGAIN
LIST LINKS AGAIN
VIEW <index>
OPEN <index>
RENAME <index> TO <new-name>
GO TO <index>
GOTO <index>
GO BACK
RETURN
DELETE <index>
HELP <command>
QUIT
EXIT
## INSTALLATION
pip install --user --upgrade docman
## RUNNING
docman
or
docman -f <start-folder>
## ENVIRONMENT VARIABLES
DOCMAN_HOME = Default <start-folder> for docman
## PROJECT STATUS
This project is just starting and is alpha status.
It is subject to change.
Please keep this in mind if you intend using it.
## LICENSE
MIT License
Raw data
{
"_id": null,
"home_page": null,
"name": "docman",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "David <c0d3@gpobox.net>",
"keywords": "documents",
"author": null,
"author_email": "David <c0d3@gpobox.net>",
"download_url": "https://files.pythonhosted.org/packages/38/6f/b0d8ec7d70307f2bd050b7868b019d5c3b4735665f10135a3b2fef97ef8e/docman-0.0.6.tar.gz",
"platform": null,
"description": "# DocMan - Document Manager\n\n DocMan is a simple text based document manager.\n It currently has zero dependencies on other packages.\n\n## Be aware\n\nIf you think this is a normal file manager you will be disappointed.\nIt is designed as a recursive document manager based on files and links.\nIt provides the appearance of a hierarchy while having a shallow directory tree.\nThis is so that multiple associations can easily be created to the same folder.\n\nA database contains folders and files.\nA folder can contain references to other folders.\nA folder can contain files.\n\nAll folders are stored in the **Database/** directory on the file system as a directory per folder.\nAll references to folders are created as symbolic links in the directory.\nAll files in the folder are stored in the directory for the folder.\n\nA database does not support creating references to files.\n\n## Commands\n\nThe following commands are supported:\n\n MENU\n LIST\n LIST LIKE <pattern>...\n LIST LINKS\n LIST LINKS LIKE <pattern>...\n LIST AGAIN\n LIST LINKS AGAIN\n VIEW <index>\n OPEN <index>\n RENAME <index> TO <new-name>\n GO TO <index>\n GOTO <index>\n GO BACK\n RETURN\n DELETE <index>\n HELP <command>\n QUIT\n EXIT\n\n## INSTALLATION\n\n pip install --user --upgrade docman\n\n## RUNNING\n\n docman\n or\n docman -f <start-folder>\n\n## ENVIRONMENT VARIABLES\n\n DOCMAN_HOME = Default <start-folder> for docman\n\n## PROJECT STATUS\n\n This project is just starting and is alpha status. \n It is subject to change.\n Please keep this in mind if you intend using it.\n\n## LICENSE\n\n MIT License\n",
"bugtrack_url": null,
"license": "Copyright \u00a9 2024 David <c0d3@gpobox.net> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \u201cSoftware\u201d), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \u201cAS IS\u201d, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Document Manager",
"version": "0.0.6",
"project_urls": {
"Bug Tracker": "https://github.com/bbc6502/docman/issues",
"Homepage": "https://github.com/bbc6502/docman"
},
"split_keywords": [
"documents"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3df70c0ecb474b3a9529312104aa5d45d245df1a816aba9575e8821bc89897f1",
"md5": "f01cc6eb5e22f467f254ddc6fb0335c9",
"sha256": "9203463275904a69c3f51fe09956a87f65f39dbe511fe2e32959e9eb0c6addf4"
},
"downloads": -1,
"filename": "docman-0.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f01cc6eb5e22f467f254ddc6fb0335c9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 10188,
"upload_time": "2024-08-13T12:46:22",
"upload_time_iso_8601": "2024-08-13T12:46:22.759214Z",
"url": "https://files.pythonhosted.org/packages/3d/f7/0c0ecb474b3a9529312104aa5d45d245df1a816aba9575e8821bc89897f1/docman-0.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "386fb0d8ec7d70307f2bd050b7868b019d5c3b4735665f10135a3b2fef97ef8e",
"md5": "d84644adc0ccef4a064b278e9312d21d",
"sha256": "1c7b3d571ab26074500d3cdfa5b268ed1b2e7dae27bd272d727b4a539689af94"
},
"downloads": -1,
"filename": "docman-0.0.6.tar.gz",
"has_sig": false,
"md5_digest": "d84644adc0ccef4a064b278e9312d21d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 10928,
"upload_time": "2024-08-13T12:46:24",
"upload_time_iso_8601": "2024-08-13T12:46:24.401003Z",
"url": "https://files.pythonhosted.org/packages/38/6f/b0d8ec7d70307f2bd050b7868b019d5c3b4735665f10135a3b2fef97ef8e/docman-0.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-13 12:46:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bbc6502",
"github_project": "docman",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "pytest",
"specs": []
},
{
"name": "pytest-cov",
"specs": []
},
{
"name": "coverage",
"specs": []
},
{
"name": "wheel",
"specs": []
},
{
"name": "build",
"specs": []
},
{
"name": "twine",
"specs": []
}
],
"lcname": "docman"
}
