[نسخه فارسی این سند](./fa.README.md)
makenote
---
a command line tool for making diary or journals.
# installation
there are a few methods for installation
## using pip
easiest way is to install it using pip:
1. install package
```bash
pip install makenote
```
for some new Gnu distros you need to use `pipx`.
```bash
pipx install makenote
```
2. add `~/.local/bin` to path if needed. ([help](https://linuxize.com/post/how-to-add-directory-to-path-in-linux/))
## build for pip
1. build the package
```bash
pip install setuptools wheel
git clone 'https://github.com/ekm507/makenote'
cd makenote
python3 setup.py bdist_wheel
```
2. install the package
```bash
pip install ./dist/*.whl
```
# usage
## adding notes
to add note to a specified notebook, run this:
```bash
makenote [-t <notebook_name>] <note_text>
```
in which note text is the note you want to be added.
for example:
```bash
makenote I am reading page 754 of the book
```
if you run this tool with no text, it will get note text from a simple prompt editor. write your text and then hit `Alt+Enter` or `ctrl+D`.
```
$ makenote
it was a great day.
I had a pizza with my friend. (ctrl+D)
1728 - Tue, 10 Bah 1402 18:55:25 - journals - note saved!
```
if you do not specify notebook name, then note will be stored in default notebook which is `journals`. you can change it in config file.
## creating notebooks
this tool uses different notebooks for storing notes.
for example you can classify your notes in "journals", "tasks", "work", etc.
to create a notebook, run this:
```bash
makenote --create <notebook_name>
```
in which `<notebook_name>` is the name of notebook you want to be created.
## listing notebooks
to get a list of notebooks you have created, run this:
```bash
makenote --list
```
## showing records
to see the notes you have stored in a notebook, run this:
```bash
makenote --show
```
if you do not specify notebook name, the default notebook will be shown. you can specify it with `-t` switch:
```bash
makenote --show -t <notebook>
```
## getting help
run command below to get a list of switches:
```bash
makenote -h
```
# configuration
a file named `makenote.conf` is copied into makenote install dir. you can edit this file to get what you want.
# export all notes
database files are stored in path specified in config file. which by default is below:
`~/.local/share/makenote/databases/`
for backing notes up, just copy the files somewhere safe.
for restoring, just copy the database into the database path again.
Raw data
{
"_id": null,
"home_page": "https://github.com/ekm507/makenote",
"name": "makenote",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "makenote",
"author": "Erfan Kheirollahi",
"author_email": "ekm507@gmail.com",
"download_url": null,
"platform": null,
"description": "[\u0646\u0633\u062e\u0647 \u0641\u0627\u0631\u0633\u06cc \u0627\u06cc\u0646 \u0633\u0646\u062f](./fa.README.md)\n\nmakenote\n---\n\na command line tool for making diary or journals.\n\n# installation\n\nthere are a few methods for installation\n\n## using pip\neasiest way is to install it using pip:\n\n1. install package\n```bash\npip install makenote\n```\n\nfor some new Gnu distros you need to use `pipx`.\n\n```bash\npipx install makenote\n```\n\n2. add `~/.local/bin` to path if needed. ([help](https://linuxize.com/post/how-to-add-directory-to-path-in-linux/))\n\n## build for pip\n\n1. build the package\n\n```bash\npip install setuptools wheel\ngit clone 'https://github.com/ekm507/makenote'\ncd makenote\npython3 setup.py bdist_wheel\n\n```\n\n2. install the package\n```bash\npip install ./dist/*.whl\n```\n\n# usage\n\n\n## adding notes\n\nto add note to a specified notebook, run this:\n```bash\nmakenote [-t <notebook_name>] <note_text>\n```\n\nin which note text is the note you want to be added.\n\nfor example:\n```bash\nmakenote I am reading page 754 of the book\n```\n\nif you run this tool with no text, it will get note text from a simple prompt editor. write your text and then hit `Alt+Enter` or `ctrl+D`.\n\n```\n$ makenote\n\nit was a great day.\nI had a pizza with my friend. (ctrl+D)\n\n1728 - Tue, 10 Bah 1402 18:55:25 - journals - note saved!\n```\n\nif you do not specify notebook name, then note will be stored in default notebook which is `journals`. you can change it in config file.\n\n\n\n## creating notebooks\n\nthis tool uses different notebooks for storing notes. \nfor example you can classify your notes in \"journals\", \"tasks\", \"work\", etc.\n\nto create a notebook, run this:\n```bash\nmakenote --create <notebook_name>\n```\nin which `<notebook_name>` is the name of notebook you want to be created.\n\n## listing notebooks\n\nto get a list of notebooks you have created, run this:\n```bash\nmakenote --list\n```\n\n## showing records\n\nto see the notes you have stored in a notebook, run this:\n```bash\nmakenote --show\n```\n\nif you do not specify notebook name, the default notebook will be shown. you can specify it with `-t` switch:\n\n```bash\nmakenote --show -t <notebook>\n```\n\n## getting help\n\nrun command below to get a list of switches:\n\n```bash\nmakenote -h\n```\n\n# configuration\n\na file named `makenote.conf` is copied into makenote install dir. you can edit this file to get what you want.\n\n# export all notes\ndatabase files are stored in path specified in config file. which by default is below:\n\n`~/.local/share/makenote/databases/`\n\nfor backing notes up, just copy the files somewhere safe.\n\nfor restoring, just copy the database into the database path again.\n",
"bugtrack_url": null,
"license": null,
"summary": "command line tool for quickly writing journals",
"version": "4.6",
"project_urls": {
"Homepage": "https://github.com/ekm507/makenote"
},
"split_keywords": [
"makenote"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f084139005b26344c71c1c67007a213c85db7e2276f4fc74c04adf36140410c4",
"md5": "82a83390c14a57878034a888bc6170a8",
"sha256": "070ed43f4879b24d34239f4cf1a71b574d19b0117c3dbdf8e43b253045ecaa74"
},
"downloads": -1,
"filename": "makenote-4.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "82a83390c14a57878034a888bc6170a8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 29343,
"upload_time": "2024-12-25T22:16:37",
"upload_time_iso_8601": "2024-12-25T22:16:37.275690Z",
"url": "https://files.pythonhosted.org/packages/f0/84/139005b26344c71c1c67007a213c85db7e2276f4fc74c04adf36140410c4/makenote-4.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-25 22:16:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ekm507",
"github_project": "makenote",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "jdatetime",
"specs": []
}
],
"lcname": "makenote"
}
JSON
