notepads-dev


Namenotepads-dev JSON
Version 2023.12.10.10 PyPI version JSON
download
home_pagehttps://github.com/py-notepads
SummaryCreate runtime folders, files, and code notes. All stored in notepads environment.
upload_time2023-12-10 07:58:25
maintainer
docs_urlNone
authornotepads
requires_python
licenseMIT
keywords notes notepad notepads np nps
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <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)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/)
[![Python Versions](https://img.shields.io/badge/python-3.7%20|%203.8%20|%203.9%20|%203.10%20|%203.11%20|%203.12%20-blue)](https://www.python.org/downloads/)

```
notepads: V2023.12.10.10
```

## Installing
```shell
# Linux/macOS
python3 pip install -U notepads

# Windows
py -3 -m pip install -U notepads
```

Create runtime only directory
    [1] -> Make folders
    [2] -> Make files
    [3] -> Make notes for code

========================================

# Directory Example Layout:
```ruby
Directory["/notepads/"]
  🗀  examples
   ↳ 🗎  example.py
  🗎  main.py
```

========================================

# Create note:
```python
notepads.note(name='notename', content='notecontent', author='OPTIONAL_noteauthor')
```
# Find note
```python
notepads.get_note(name='notename')

# or

notepads.notes()[<index>]
```
========================================

# Create folder:
```python
notepads.folder(name='foldername', version='OPTIONAL_0.0.0', description='OPTIONAL_a test folder', author='OPTIONAL_test author'))

# name, *, version=None, description=None, author=None
```

# Find folder:
```python
notepads.get(name='foldername')
```

# Update folder:
```python
folder.update(name='newfoldername', version='0.0.1', description='a new test folder', author='test author')
```

# Delete folder:
```python
folder.delete()
```

========================================

# Create file:
```python
notepads.file(name='filename', description='OPTIONAL_a test file', author='OPTIONAL_test author', parent='OPTIONAL_folder name')

# name, *, version=None, description=None, author=None, parent: NotepadsFolder=None
```

# Find file:
```python
notepads.get(name='filename')
```

# Update file:
```python
file.update(name='newfilename', description='a new test file', author='test author)
```

# Load file:
```python
file.load()
```

# Write file:
```python
file.write(content='newfilecontent')
```

# Delete file:
```python
file.delete()
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/py-notepads",
    "name": "notepads-dev",
    "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/55/dc/70fa15e5292e4cc84ce466965783887050bad83d1078d6700959fbf2fc88/notepads-dev-2023.12.10.10.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[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/)\n[![Python Versions](https://img.shields.io/badge/python-3.7%20|%203.8%20|%203.9%20|%203.10%20|%203.11%20|%203.12%20-blue)](https://www.python.org/downloads/)\n\n```\nnotepads: V2023.12.10.10\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\nCreate runtime only directory\n    [1] -> Make folders\n    [2] -> Make files\n    [3] -> Make notes for code\n\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# Create note:\n```python\nnotepads.note(name='notename', content='notecontent', author='OPTIONAL_noteauthor')\n```\n# Find note\n```python\nnotepads.get_note(name='notename')\n\n# or\n\nnotepads.notes()[<index>]\n```\n========================================\n\n# Create folder:\n```python\nnotepads.folder(name='foldername', version='OPTIONAL_0.0.0', description='OPTIONAL_a test folder', author='OPTIONAL_test author'))\n\n# name, *, version=None, description=None, author=None\n```\n\n# Find folder:\n```python\nnotepads.get(name='foldername')\n```\n\n# Update folder:\n```python\nfolder.update(name='newfoldername', version='0.0.1', description='a new test folder', author='test author')\n```\n\n# Delete folder:\n```python\nfolder.delete()\n```\n\n========================================\n\n# Create file:\n```python\nnotepads.file(name='filename', description='OPTIONAL_a test file', author='OPTIONAL_test author', parent='OPTIONAL_folder name')\n\n# name, *, version=None, description=None, author=None, parent: NotepadsFolder=None\n```\n\n# Find file:\n```python\nnotepads.get(name='filename')\n```\n\n# Update file:\n```python\nfile.update(name='newfilename', description='a new test file', author='test author)\n```\n\n# Load file:\n```python\nfile.load()\n```\n\n# Write file:\n```python\nfile.write(content='newfilecontent')\n```\n\n# Delete file:\n```python\nfile.delete()\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Create runtime folders, files, and code notes. All stored in notepads environment.",
    "version": "2023.12.10.10",
    "project_urls": {
        "Homepage": "https://github.com/py-notepads"
    },
    "split_keywords": [
        "notes",
        "notepad",
        "notepads",
        "np",
        "nps"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "cfe490851547cdb7e193dc93ad3fe6d8f0d3c71b133b99ea394079c4a51d71a4",
                "md5": "ee08dcda85cc8b5257cbe921b0d17ded",
                "sha256": "f211decf01dd7a68ab623f2e7f8a7b19c22fd48667e7979c2ebd5f2f731c91a3"
            },
            "downloads": -1,
            "filename": "notepads_dev-2023.12.10.10-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ee08dcda85cc8b5257cbe921b0d17ded",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 14240,
            "upload_time": "2023-12-10T07:58:23",
            "upload_time_iso_8601": "2023-12-10T07:58:23.533045Z",
            "url": "https://files.pythonhosted.org/packages/cf/e4/90851547cdb7e193dc93ad3fe6d8f0d3c71b133b99ea394079c4a51d71a4/notepads_dev-2023.12.10.10-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "55dc70fa15e5292e4cc84ce466965783887050bad83d1078d6700959fbf2fc88",
                "md5": "5502f61a367eed4bf2340a883378e441",
                "sha256": "1db7f021c6f32adebf2f5d791ffedf6ef0885ec833bd8f6261ebffd5677b22fa"
            },
            "downloads": -1,
            "filename": "notepads-dev-2023.12.10.10.tar.gz",
            "has_sig": false,
            "md5_digest": "5502f61a367eed4bf2340a883378e441",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 812239,
            "upload_time": "2023-12-10T07:58:25",
            "upload_time_iso_8601": "2023-12-10T07:58:25.468616Z",
            "url": "https://files.pythonhosted.org/packages/55/dc/70fa15e5292e4cc84ce466965783887050bad83d1078d6700959fbf2fc88/notepads-dev-2023.12.10.10.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-10 07:58:25",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "notepads-dev"
}
        
Elapsed time: 0.73635s