<h1 align="center">
<a href="https://pypi.org/project/notepads"><img src="https://i.ibb.co/D71Jnvz/sketch1702189741549-modified.png" width="400"></a>
</h1>
# [notepads - PyPi](https://pypi.org/project/notepads)
[](https://github.com/notepads-py/notepads/blob/main/LICENSE)
[](https://www.python.org/downloads/)
```
notepads: V5.8.0
```
## Installing
```shell
# Linux/macOS
python3 pip install -U notepads
# Windows
py -3 -m pip install -U notepads
```
### Supports TypeHints
Create runtime only directory
[1] -> Make folders
[2] -> Make files
[3] -> Make notes for code
========================================
```python
# View Directory:
notepads.directory
notepads.dir
notepads.source
notepads.src
```
# Directory Example Layout:
```ruby
Directory["/notepads/"]
🗀 examples
↳ 🗎 example.py
🗎 main.py
```
========================================
# Usage <h6>100ms | (Average)</h6>
```python
import notepads
notepads.note \
(name="introduction",
content="""Create runtime only directory
[1] -> Make folders
[2] -> Make files
[3] -> Make notes for code""",
author = "'notepads.py' Team")
print(notepads.get_note('introduction').content)
"""
Lets create a file `nps.txt` and a folder `examples` in the directory.
"""
notepads.folder \
(name="examples",
description="Examples of using notepads.",
version="0.1.0",
author="'notepads.py' Team",
some_random_kwarg='hi there!')
# folder.some_random_kwarg
# >>> hi there!
"""
Any other kwarg you pass in will be saved as a variable for you to access later.
"""
notepads.file \
(name="nps.txt",
description="This is a file.",
version="0.1.0",
author="'notepads.py' Team")
print(notepads.directory) # notepads.dir | notepads.source | notepads.src
"""
Output:
Directory["/notepads/"]
🗀 examples
🗎 nps.txt
"""
"""
Lets add a file `test.py` to the `examples` folder.
"""
notepads.file \
(name="test.py",
parent='examples')
print(notepads.directory) # notepads.dir | notepads.source | notepads.src
"""
Output:
Directory["/notepads/"]
🗀 examples
↳ 🗎 test.py
🗎 nps.txt
"""
"""
Now lets write to some files!
"""
nps_file = notepads.get('nps.txt')
test_file = notepads.get('examples').get('test.py')
nps_file.write("Hello, World!")
test_file.write("print('Hello, World!')")
print(nps_file.read())
print(test_file.read())
"""
nps.txt:
Hello, World!
test.py:
print('Hello, World!')
"""
nps_file.wipe()
print(nps_file.read())
"""
Output:
"""
```
Raw data
{
"_id": null,
"home_page": "https://github.com/notepads-py",
"name": "notepads",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "notes,notepad,notepads,np,nps",
"author": "notepads",
"author_email": "notepads.py@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/83/e6/96cb7c534fe5d2d1633a21d2dc09953dcd99ca1a17d0f1c4d074e10c8d73/notepads-5.8.0.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">\n <a href=\"https://pypi.org/project/notepads\"><img src=\"https://i.ibb.co/D71Jnvz/sketch1702189741549-modified.png\" width=\"400\"></a>\n</h1>\n\n\n# [notepads - PyPi](https://pypi.org/project/notepads)\n[](https://github.com/notepads-py/notepads/blob/main/LICENSE)\n[](https://www.python.org/downloads/)\n\n```\nnotepads: V5.8.0\n```\n\n## Installing\n```shell\n# Linux/macOS\npython3 pip install -U notepads\n\n# Windows\npy -3 -m pip install -U notepads\n```\n\n### Supports TypeHints\n\nCreate runtime only directory\n [1] -> Make folders\n [2] -> Make files\n [3] -> Make notes for code\n\n========================================\n\n```python\n# View Directory:\n\nnotepads.directory\nnotepads.dir\nnotepads.source\nnotepads.src\n```\n\n# Directory Example Layout:\n```ruby\nDirectory[\"/notepads/\"]\n \ud83d\uddc0 examples\n \u21b3 \ud83d\uddce example.py\n \ud83d\uddce main.py\n```\n\n========================================\n\n\n# Usage <h6>100ms | (Average)</h6>\n```python\nimport notepads\n\nnotepads.note \\\n (name=\"introduction\",\n \n content=\"\"\"Create runtime only directory \n [1] -> Make folders \n [2] -> Make files \n [3] -> Make notes for code\"\"\",\n \n author = \"'notepads.py' Team\")\n\nprint(notepads.get_note('introduction').content)\n\n\"\"\"\nLets create a file `nps.txt` and a folder `examples` in the directory.\n\"\"\"\n\nnotepads.folder \\\n (name=\"examples\",\n description=\"Examples of using notepads.\",\n version=\"0.1.0\",\n author=\"'notepads.py' Team\",\n some_random_kwarg='hi there!')\n\n# folder.some_random_kwarg\n# >>> hi there!\n\n\"\"\"\nAny other kwarg you pass in will be saved as a variable for you to access later.\n\"\"\"\n\nnotepads.file \\\n (name=\"nps.txt\",\n description=\"This is a file.\",\n version=\"0.1.0\",\n author=\"'notepads.py' Team\")\n\nprint(notepads.directory) # notepads.dir | notepads.source | notepads.src\n\n\"\"\"\nOutput:\n\nDirectory[\"/notepads/\"]\n \ud83d\uddc0 examples\n \ud83d\uddce nps.txt\n\"\"\"\n\n\"\"\"\nLets add a file `test.py` to the `examples` folder.\n\"\"\"\n\nnotepads.file \\\n (name=\"test.py\",\n parent='examples')\n\nprint(notepads.directory) # notepads.dir | notepads.source | notepads.src\n\n\"\"\"\nOutput:\n\nDirectory[\"/notepads/\"]\n \ud83d\uddc0 examples\n \u21b3 \ud83d\uddce test.py\n \ud83d\uddce nps.txt\n\"\"\"\n\n\"\"\"\nNow lets write to some files!\n\"\"\"\n\nnps_file = notepads.get('nps.txt')\ntest_file = notepads.get('examples').get('test.py')\n\nnps_file.write(\"Hello, World!\")\ntest_file.write(\"print('Hello, World!')\")\n\nprint(nps_file.read())\nprint(test_file.read())\n\n\"\"\"\nnps.txt:\n\nHello, World!\n\ntest.py:\nprint('Hello, World!')\n\"\"\"\n\nnps_file.wipe()\n\nprint(nps_file.read())\n\n\"\"\"\nOutput:\n\n\n\"\"\"\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "\u3164",
"version": "5.8.0",
"project_urls": {
"Download": "https://pypi.org/project/notepads/",
"Homepage": "https://github.com/notepads-py",
"Source": "https://github.com/notepads-py"
},
"split_keywords": [
"notes",
"notepad",
"notepads",
"np",
"nps"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "36f2fa661cef7daff430759fd0d213794c06a6d430f538c74f8825a683c20496",
"md5": "d40c5a1381f7e2fcc2d9d2448c4b35ce",
"sha256": "d57aa190be32364dcfefcb9d3a19fdb09b6650da7b1b466cb4ea4e7034c6b6ad"
},
"downloads": -1,
"filename": "notepads-5.8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d40c5a1381f7e2fcc2d9d2448c4b35ce",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 15217,
"upload_time": "2023-12-10T19:12:12",
"upload_time_iso_8601": "2023-12-10T19:12:12.045780Z",
"url": "https://files.pythonhosted.org/packages/36/f2/fa661cef7daff430759fd0d213794c06a6d430f538c74f8825a683c20496/notepads-5.8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "83e696cb7c534fe5d2d1633a21d2dc09953dcd99ca1a17d0f1c4d074e10c8d73",
"md5": "f55e9669a8a005bd6ed09431db5c8e9a",
"sha256": "49dd3612249653441656c537256c6a264cb544ec02defe6ee9b07655f641b0c6"
},
"downloads": -1,
"filename": "notepads-5.8.0.tar.gz",
"has_sig": false,
"md5_digest": "f55e9669a8a005bd6ed09431db5c8e9a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 813636,
"upload_time": "2023-12-10T19:12:13",
"upload_time_iso_8601": "2023-12-10T19:12:13.883459Z",
"url": "https://files.pythonhosted.org/packages/83/e6/96cb7c534fe5d2d1633a21d2dc09953dcd99ca1a17d0f1c4d074e10c8d73/notepads-5.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-10 19:12:13",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "notepads"
}
JSON