| Name | nanodoc JSON |
| Version |
0.9.2
JSON |
| download |
| home_page | None |
| Summary | A minimalist document bundler designed for stitching hints, reminders and short docs. |
| upload_time | 2025-03-16 21:26:12 |
| maintainer | None |
| docs_url | None |
| author | Arthur Debert |
| requires_python | >=3.9 |
| license | # License
MIT License
Copyright (c) 2024 Arthur Debert
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, innerlicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, innerject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or innerstantial 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 NON-INFRINGEMENT. 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 |
documentation
bundler
minimalist
text
prompts
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
Nanodoc
--------
Nanodoc is a minimalist document bundler designed for stiching hints, reminders and short docs.
Useful for prompts, personalized docs highlights for your teams or a note to your future self
No config, nothing to learn nor remember. Short , simple, sweet.
Features
--------
- No config, no tutorial, no pain.
- Combines multiple text files into a single document
- Adds clear title separators between pages
- Supports optional line numbering (per file or global)
- Can generate a table of contents
- Flexible file selection methods
- Customizable header styles and sequence numbering
Usage
-----
$ nanodoc file1.txt file2.txt
$ nanodoc -n file1.txt file2.txt # Per-file line numbering
$ nanodoc -nn file1.txt file2.txt # Global line numbering
$ nanodoc -nn --toc file1.txt file2.txt # Global numbering with TOC
File Selection Options
----------------------
Nanodoc is flexible in how you specify the files to bundle:
$ nanodoc <file-1>...<file-n> # individual files
$ nanodoc <dir-name> # all txt and md files in the dir will be included
$ nanodoc <dir-name> <file-1> # mix and match as you'd like
$ nanodoc <bundle> # any .bundle.* file that is a list of paths, one per line
$ nanodoc <live-bundle> # a file that mixes text and file paths, where paths are replaced with their content
Get only parts of a file:
$ nanodoc readme.txt:L14-16,L30-50 # get the good parts only
Command Line Options
--------------------
- `-n`: Add per-file line numbering (01, 02, etc.)
- `-nn`: Add global line numbering: useful for referencing the full doc gen later
- `--toc`: Generate a table of contents at the beginning
Get fancy
---------
- `--seq`: numerical, roman or letter for ref the file sequence
- `--style`: nice (Human Readable (human-readable.txt), or file, or full-path
Save for later:
---------------
Generated a doc good enough to repeat, export the bundle
$nanodoc --export-bundle bestdocs.bundle.txt <file-1>...<file-n>
Keep it simple
--------------
Nothing to config.
Nothing to learn.
No tutorials to watch.
In fact, you've just went through the full documentation.
$ nanodoc --help # all there is
## Installation
nanodoc is available at a distributor near you:
# Using pip
pip install nanodoc
# even better pipx
pipx install --user nanodoc
## Contributing
Contributions are welcome! Say hi, curse me for eternity or even send in something constructive.
Feel free to open issues or submit pull requests.
(just keep it short, we're nano people after all)
## License
MIT License
Raw data
{
"_id": null,
"home_page": null,
"name": "nanodoc",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "documentation, bundler, minimalist, text, prompts",
"author": "Arthur Debert",
"author_email": "arthur@debert.xyz",
"download_url": "https://files.pythonhosted.org/packages/b2/ab/414e77fab125da0f5a89e22139b15a3c129e5bac06cac903ddcbb539c5cb/nanodoc-0.9.2.tar.gz",
"platform": null,
"description": "Nanodoc\n--------\n\nNanodoc is a minimalist document bundler designed for stiching hints, reminders and short docs.\nUseful for prompts, personalized docs highlights for your teams or a note to your future self\n\nNo config, nothing to learn nor remember. Short , simple, sweet.\n\nFeatures\n--------\n\n- No config, no tutorial, no pain.\n- Combines multiple text files into a single document\n- Adds clear title separators between pages\n- Supports optional line numbering (per file or global)\n- Can generate a table of contents\n- Flexible file selection methods\n- Customizable header styles and sequence numbering\n\nUsage\n-----\n\n$ nanodoc file1.txt file2.txt\n\n\n$ nanodoc -n file1.txt file2.txt # Per-file line numbering\n$ nanodoc -nn file1.txt file2.txt # Global line numbering\n$ nanodoc -nn --toc file1.txt file2.txt # Global numbering with TOC\n\nFile Selection Options\n----------------------\n\nNanodoc is flexible in how you specify the files to bundle:\n\n$ nanodoc <file-1>...<file-n> # individual files\n$ nanodoc <dir-name> # all txt and md files in the dir will be included\n$ nanodoc <dir-name> <file-1> # mix and match as you'd like\n$ nanodoc <bundle> # any .bundle.* file that is a list of paths, one per line\n$ nanodoc <live-bundle> # a file that mixes text and file paths, where paths are replaced with their content\n\nGet only parts of a file:\n\n$ nanodoc readme.txt:L14-16,L30-50 # get the good parts only\n\nCommand Line Options\n--------------------\n\n- `-n`: Add per-file line numbering (01, 02, etc.)\n- `-nn`: Add global line numbering: useful for referencing the full doc gen later\n- `--toc`: Generate a table of contents at the beginning\n\nGet fancy\n---------\n\n- `--seq`: numerical, roman or letter for ref the file sequence\n- `--style`: nice (Human Readable (human-readable.txt), or file, or full-path\n\nSave for later:\n---------------\n\nGenerated a doc good enough to repeat, export the bundle\n\n$nanodoc --export-bundle bestdocs.bundle.txt <file-1>...<file-n>\n\nKeep it simple\n--------------\n\nNothing to config.\nNothing to learn.\nNo tutorials to watch.\n\nIn fact, you've just went through the full documentation.\n$ nanodoc --help # all there is\n\n\n## Installation\n\nnanodoc is available at a distributor near you:\n\n# Using pip\npip install nanodoc\n# even better pipx\npipx install --user nanodoc\n\n## Contributing\n\nContributions are welcome! Say hi, curse me for eternity or even send in something constructive.\nFeel free to open issues or submit pull requests.\n\n(just keep it short, we're nano people after all)\n\n## License\n\nMIT License\n\n",
"bugtrack_url": null,
"license": "# License\n \n MIT License\n \n Copyright (c) 2024 Arthur Debert\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, innerlicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, innerject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or innerstantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.",
"summary": "A minimalist document bundler designed for stitching hints, reminders and short docs.",
"version": "0.9.2",
"project_urls": {
"Bug Tracker": "https://github.com/arthur-debert/nanodoc/issues",
"Homepage": "https://github.com/arthur-debert/nanodoc/",
"Repository": "https://github.com/arthur-debert/nanodoc/"
},
"split_keywords": [
"documentation",
" bundler",
" minimalist",
" text",
" prompts"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "fafdd58e53ce937f65ddde391385b7d2e8916f6c414f12e6532fd418df618ccd",
"md5": "317fb2f17bd3c1a1f9d186cf8c16c9a0",
"sha256": "8d6df50a89edc82cb56d2b97c4f25578da7d876db60b8c9e3f449181079f0fd5"
},
"downloads": -1,
"filename": "nanodoc-0.9.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "317fb2f17bd3c1a1f9d186cf8c16c9a0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 23510,
"upload_time": "2025-03-16T21:26:11",
"upload_time_iso_8601": "2025-03-16T21:26:11.231156Z",
"url": "https://files.pythonhosted.org/packages/fa/fd/d58e53ce937f65ddde391385b7d2e8916f6c414f12e6532fd418df618ccd/nanodoc-0.9.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "b2ab414e77fab125da0f5a89e22139b15a3c129e5bac06cac903ddcbb539c5cb",
"md5": "7769d108205ec9b5879b1bc5dbdb3e6c",
"sha256": "625956e6ef907a1be28532d91e3c8f2c2fd0817f1d108fe822eecb0e70fbe07a"
},
"downloads": -1,
"filename": "nanodoc-0.9.2.tar.gz",
"has_sig": false,
"md5_digest": "7769d108205ec9b5879b1bc5dbdb3e6c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 19350,
"upload_time": "2025-03-16T21:26:12",
"upload_time_iso_8601": "2025-03-16T21:26:12.210307Z",
"url": "https://files.pythonhosted.org/packages/b2/ab/414e77fab125da0f5a89e22139b15a3c129e5bac06cac903ddcbb539c5cb/nanodoc-0.9.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-03-16 21:26:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "arthur-debert",
"github_project": "nanodoc",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "nanodoc"
}
