# NotPy
A command line tool to manage markdown files for taking notes.
[](https://github.com/jontok/Notpy/actions/workflows/build_and_test.yml)
## Introduction
NotPy is a tool to help you manage markdown files for taking notes. You can create, edit, and delete notebooks and pages with simple CLI commands. NotPy is built using Python, and it uses some third-party libraries such as `click`, `pathlib`, and `toml`.
## Getting started
To use NotPy, you need to install Python 3.6 or later. To install NotPy, clone the repository and install the requirements:
```
git clone https://github.com/NotPy/notpy.git
cd notpy
pip install -r requirements.txt
```
To start NotPy, you can run the command:
```
python notpy.py
```
You can also run NotPy from anywhere by adding the path to the `notpy.py` file to your system's `PATH` variable.
## Usage
NotPy has four main commands: `ls`, `edit`, `create`, and `delete`.
### `ls`
The `ls` command is used to list notebooks and pages. To list notebooks, use the command:
```
notpy ls nb
```
To list pages in a notebook, use the command:
```
notpy ls pg <notebook_id_or_name>
```
Replace `<notebook_id_or_name>` with the ID or name of the notebook you want to list the pages for.
### `edit`
The `edit` command is used to edit pages. To edit a page, use the command:
```
notpy edit pg <notebook_id_or_name> <page_id_or_name>
```
Replace `<notebook_id_or_name>` with the ID or name of the notebook the page is in, and replace `<page_id_or_name>` with the ID or name of the page you want to edit.
### `create`
The `create` command is used to create notebooks and pages. To create a notebook, use the command:
```
notpy create nb <notebook_id_or_name>
```
Replace `<notebook_id_or_name>` with the ID or name of the notebook you want to create.
To create a page, use the command:
```
notpy create pg <notebook_id_or_name> <page_name>
```
Replace `<notebook_id_or_name>` with the ID or name of the notebook you want to create the page in, and replace `<page_name>` with the name of the page you want to create.
### `delete`
The `delete` command is used to delete notebooks and pages. To delete a notebook, use the command:
```
notpy delete nb <notebook_id_or_name>
```
Replace `<notebook_id_or_name>` with the ID or name of the notebook you want to delete.
To delete a page, use the command:
```
notpy delete pg <notebook_id_or_name> <page_id_or_name>
```
Replace `<notebook_id_or_name>` with the ID or name of the notebook the page is in, and replace `<page_id_or_name>` with the ID or name of the page you want to delete.
## Configuration
NotPy reads its configuration from a JSON file located at `$HOME/.config/notpy/config.json`. You can modify this file to change the default settings for NotPy.
## Contributing
Contributions to NotPy are welcome! If you find a bug, have a feature request, or want to contribute code, please create an issue or a pull request on GitHub.
## License
NotPy is licensed under the GPLv3 License. See the LICENSE file for more information.
Raw data
{
"_id": null,
"home_page": "https://github.com/jontok/Notpy",
"name": "notpy",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<4.0",
"maintainer_email": "",
"keywords": "notes,markdown,python,nvim,neovim",
"author": "jontok",
"author_email": "jonas@tokmaji.de",
"download_url": "https://files.pythonhosted.org/packages/a0/89/f31acafec1a3e1d10732d7282c21960a60c4e35adbc5213fa08e8e04a93e/notpy-0.0.5.tar.gz",
"platform": null,
"description": "# NotPy\nA command line tool to manage markdown files for taking notes.\n\n[](https://github.com/jontok/Notpy/actions/workflows/build_and_test.yml)\n\n## Introduction\nNotPy is a tool to help you manage markdown files for taking notes. You can create, edit, and delete notebooks and pages with simple CLI commands. NotPy is built using Python, and it uses some third-party libraries such as `click`, `pathlib`, and `toml`.\n\n## Getting started\nTo use NotPy, you need to install Python 3.6 or later. To install NotPy, clone the repository and install the requirements:\n\n\n```\n\ngit clone https://github.com/NotPy/notpy.git\ncd notpy\npip install -r requirements.txt\n\n```\n\nTo start NotPy, you can run the command:\n\n```\npython notpy.py\n```\n\nYou can also run NotPy from anywhere by adding the path to the `notpy.py` file to your system's `PATH` variable.\n\n## Usage\nNotPy has four main commands: `ls`, `edit`, `create`, and `delete`.\n\n### `ls`\nThe `ls` command is used to list notebooks and pages. To list notebooks, use the command:\n\n```\nnotpy ls nb\n```\n\nTo list pages in a notebook, use the command:\n\n```\nnotpy ls pg <notebook_id_or_name>\n```\n\nReplace `<notebook_id_or_name>` with the ID or name of the notebook you want to list the pages for.\n\n### `edit`\nThe `edit` command is used to edit pages. To edit a page, use the command:\n\n```\nnotpy edit pg <notebook_id_or_name> <page_id_or_name>\n```\n\nReplace `<notebook_id_or_name>` with the ID or name of the notebook the page is in, and replace `<page_id_or_name>` with the ID or name of the page you want to edit.\n\n### `create`\nThe `create` command is used to create notebooks and pages. To create a notebook, use the command:\n\n```\nnotpy create nb <notebook_id_or_name>\n```\n\nReplace `<notebook_id_or_name>` with the ID or name of the notebook you want to create.\n\nTo create a page, use the command:\n\n```\nnotpy create pg <notebook_id_or_name> <page_name>\n```\n\nReplace `<notebook_id_or_name>` with the ID or name of the notebook you want to create the page in, and replace `<page_name>` with the name of the page you want to create.\n\n### `delete`\nThe `delete` command is used to delete notebooks and pages. To delete a notebook, use the command:\n\n```\nnotpy delete nb <notebook_id_or_name>\n```\n\nReplace `<notebook_id_or_name>` with the ID or name of the notebook you want to delete.\n\nTo delete a page, use the command:\n\n```\nnotpy delete pg <notebook_id_or_name> <page_id_or_name>\n```\n\nReplace `<notebook_id_or_name>` with the ID or name of the notebook the page is in, and replace `<page_id_or_name>` with the ID or name of the page you want to delete.\n\n## Configuration\nNotPy reads its configuration from a JSON file located at `$HOME/.config/notpy/config.json`. You can modify this file to change the default settings for NotPy.\n\n## Contributing\nContributions to NotPy are welcome! If you find a bug, have a feature request, or want to contribute code, please create an issue or a pull request on GitHub.\n\n## License\nNotPy is licensed under the GPLv3 License. See the LICENSE file for more information.\n\n",
"bugtrack_url": null,
"license": "GPL-3.0-only",
"summary": "Create/Delete files and edit them as markdown files in your text editor",
"version": "0.0.5",
"project_urls": {
"Documentation": "https://github.com/jontok/Notpy/blob/master/README.md",
"Homepage": "https://github.com/jontok/Notpy",
"Repository": "https://github.com/jontok/Notpy"
},
"split_keywords": [
"notes",
"markdown",
"python",
"nvim",
"neovim"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "66d511e176702db57e5ca0e11098c97a41b6cc9cd14ff2996374f9d6790c3ce0",
"md5": "32a92905e33a799f5396ae6456789bc5",
"sha256": "61120b88bd7899c50ae46dd3dbd95197e95f2cbe75c06b39bfdf7c89e80ab257"
},
"downloads": -1,
"filename": "notpy-0.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "32a92905e33a799f5396ae6456789bc5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4.0",
"size": 24729,
"upload_time": "2023-11-19T23:02:54",
"upload_time_iso_8601": "2023-11-19T23:02:54.714190Z",
"url": "https://files.pythonhosted.org/packages/66/d5/11e176702db57e5ca0e11098c97a41b6cc9cd14ff2996374f9d6790c3ce0/notpy-0.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a089f31acafec1a3e1d10732d7282c21960a60c4e35adbc5213fa08e8e04a93e",
"md5": "b2a86e195ff749182259b36c2fa9dd68",
"sha256": "6389e7b649529685b2162dd50c47d7f0ac0bb851cb340138ed03d3ef57dbc3b0"
},
"downloads": -1,
"filename": "notpy-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "b2a86e195ff749182259b36c2fa9dd68",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4.0",
"size": 21134,
"upload_time": "2023-11-19T23:02:55",
"upload_time_iso_8601": "2023-11-19T23:02:55.852017Z",
"url": "https://files.pythonhosted.org/packages/a0/89/f31acafec1a3e1d10732d7282c21960a60c4e35adbc5213fa08e8e04a93e/notpy-0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-19 23:02:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jontok",
"github_project": "Notpy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "notpy"
}
JSON
