| Name | docs-reader JSON |
| Version |
0.1.0.post1
JSON |
| download |
| home_page | None |
| Summary | To track previous or nearest import lines and show helper documents automatically |
| upload_time | 2025-08-20 05:20:38 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| license | MIT |
| keywords |
docs
automation
helper
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# docs_reader
- A simple tool to track previous or just nearest (immediate) import lines and show helper documents automatically.
## installation
```bash
pip install docs-reader
or
pip install docs_reader
```
## usage
```python
1. ...
2. from doc_reader import DocsReader
3. DocsReader()
4. ...
5. ...
```
- desciptions:
- it should be imported after <your import module> statement, not in top or first line, otherwise it will be dectect nothing.
- <your import module> statement
- than the next line will be -> <code>from doc_reader import DocsReader</code>
- than -> <code>DocsReader()</code>
## Examples:
- this tool / module help to automatically find and show the essentials documents of the given nearest import module with offline mode.
### Examples:
- example 1:
- import in your <filename>.py (e.g. main.py)
```python
1. import numpy # this will be first line
2. from docs_reader import DocsReader # next one
3. DocsReader() # next one
4. ...
descriptions
# run the <file>.py (e.g. python main.py)
# after that it will automatically show it's documentation.
1. in the above 'numpy' is import that's why it show only 'numpy' documentation.
```
- example 2:
- if your file has contained multiple import statement than it will detect the just (immediate) previous import line and it shows the helper documnetation in your terminal by running your
<code>filename.py</code> file.
```python
1. import numpy # first one
2. import pandas as pd # this is the immediate previous line of DocsReader
3. from doc_reader import DocsReader
4. DocsReader()
5. ...
descriptions:
# run the <file>.py (e.g. python main.py)
# now it show only the nearest modules documentation of pandas as: pd.
```
- example 3:
- if any newline is contains before the <code>from doc_reader import DocsReader</code> , it can't be parse.
```python
1. import numpy
2. import pandas as pd
3. # this is a newline, can't be parse
4. from doc_reader import DocsReader
5. DocsReader()
6. ....
descriptions:
# run the <file>.py (e.g. python main.py)
# it will show that "could not parse the module" if newlines are contains.
```
## bugs fix
- it's just a beta version, still working.
- if any bugs found than let me know
## module version
<code> __version__ = 0.1.0 </code>
## author
- Anjan maity
## contact
- [Email Me](mailto:anjanmaity1824@gmail.com?subject=Your%20Subject&body=Your%20Body%20Text)
Raw data
{
"_id": null,
"home_page": null,
"name": "docs-reader",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "docs, automation, helper",
"author": null,
"author_email": "Anjan Maity <anjanmaity1824@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/c8/7e/dce94a4e3261117fce24a606739bb1f850bf6d9985092558cdd3de5e11d0/docs_reader-0.1.0.post1.tar.gz",
"platform": null,
"description": "# docs_reader\r\n\r\n- A simple tool to track previous or just nearest (immediate) import lines and show helper documents automatically.\r\n\r\n## installation\r\n\r\n```bash\r\npip install docs-reader\r\nor\r\npip install docs_reader\r\n```\r\n\r\n## usage\r\n```python\r\n 1. ...\r\n 2. from doc_reader import DocsReader\r\n 3. DocsReader()\r\n 4. ...\r\n 5. ...\r\n```\r\n - desciptions:\r\n - it should be imported after <your import module> statement, not in top or first line, otherwise it will be dectect nothing.\r\n - <your import module> statement\r\n - than the next line will be -> <code>from doc_reader import DocsReader</code> \r\n - than -> <code>DocsReader()</code>\r\n \r\n## Examples:\r\n\r\n- this tool / module help to automatically find and show the essentials documents of the given nearest import module with offline mode.\r\n\r\n ### Examples:\r\n - example 1: \r\n - import in your <filename>.py (e.g. main.py)\r\n\r\n ```python\r\n 1. import numpy # this will be first line\r\n 2. from docs_reader import DocsReader # next one\r\n 3. DocsReader() # next one\r\n 4. ...\r\n \r\n descriptions\r\n # run the <file>.py (e.g. python main.py)\r\n # after that it will automatically show it's documentation.\r\n 1. in the above 'numpy' is import that's why it show only 'numpy' documentation.\r\n ```\r\n \r\n - example 2:\r\n - if your file has contained multiple import statement than it will detect the just (immediate) previous import line and it shows the helper documnetation in your terminal by running your \r\n <code>filename.py</code> file.\r\n ```python\r\n 1. import numpy # first one\r\n 2. import pandas as pd # this is the immediate previous line of DocsReader\r\n 3. from doc_reader import DocsReader\r\n 4. DocsReader()\r\n 5. ...\r\n \r\n descriptions:\r\n # run the <file>.py (e.g. python main.py)\r\n # now it show only the nearest modules documentation of pandas as: pd.\r\n ```\r\n - example 3:\r\n - if any newline is contains before the <code>from doc_reader import DocsReader</code> , it can't be parse.\r\n ```python\r\n 1. import numpy\r\n 2. import pandas as pd\r\n 3. # this is a newline, can't be parse\r\n 4. from doc_reader import DocsReader\r\n 5. DocsReader()\r\n 6. ....\r\n \r\n descriptions:\r\n # run the <file>.py (e.g. python main.py)\r\n # it will show that \"could not parse the module\" if newlines are contains.\r\n ```\r\n\r\n## bugs fix\r\n- it's just a beta version, still working.\r\n- if any bugs found than let me know\r\n\r\n## module version\r\n<code> __version__ = 0.1.0 </code>\r\n\r\n\r\n## author \r\n- Anjan maity\r\n\r\n## contact\r\n- [Email Me](mailto:anjanmaity1824@gmail.com?subject=Your%20Subject&body=Your%20Body%20Text)\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "To track previous or nearest import lines and show helper documents automatically",
"version": "0.1.0.post1",
"project_urls": {
"Homepage": "https://github.com/AnjanGitHub4/docs_reader",
"Repository": "https://github.com/AnjanGitHub4/docs_reader"
},
"split_keywords": [
"docs",
" automation",
" helper"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "95b08ee04e96922358d31de268b2861e47424ac58ab87451156a1a448aa68594",
"md5": "29468e4d14ec0e8072d9a428bcd93c05",
"sha256": "b6ca40e53766a288ae45f805c8ed3fc180b77add04adf693033895e98e401fde"
},
"downloads": -1,
"filename": "docs_reader-0.1.0.post1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "29468e4d14ec0e8072d9a428bcd93c05",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 3629,
"upload_time": "2025-08-20T05:20:37",
"upload_time_iso_8601": "2025-08-20T05:20:37.233269Z",
"url": "https://files.pythonhosted.org/packages/95/b0/8ee04e96922358d31de268b2861e47424ac58ab87451156a1a448aa68594/docs_reader-0.1.0.post1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "c87edce94a4e3261117fce24a606739bb1f850bf6d9985092558cdd3de5e11d0",
"md5": "9c1c3531b507dec0a041baa1025ae3d6",
"sha256": "b9cf13df37954919b4056c7696790f0c6a8d618576390cd1adf814e2cb53bddf"
},
"downloads": -1,
"filename": "docs_reader-0.1.0.post1.tar.gz",
"has_sig": false,
"md5_digest": "9c1c3531b507dec0a041baa1025ae3d6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3010,
"upload_time": "2025-08-20T05:20:38",
"upload_time_iso_8601": "2025-08-20T05:20:38.760405Z",
"url": "https://files.pythonhosted.org/packages/c8/7e/dce94a4e3261117fce24a606739bb1f850bf6d9985092558cdd3de5e11d0/docs_reader-0.1.0.post1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-20 05:20:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "AnjanGitHub4",
"github_project": "docs_reader",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "docs-reader"
}
