https://github.com/afonsopacifer/pynotes
Create daily notes/log with markdown.
https://github.com/afonsopacifer/pynotes
cli daily log notes productivity tool
Last synced: 11 months ago
JSON representation
Create daily notes/log with markdown.
- Host: GitHub
- URL: https://github.com/afonsopacifer/pynotes
- Owner: afonsopacifer
- License: mit
- Created: 2018-07-24T04:43:27.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-07-28T02:43:08.000Z (almost 8 years ago)
- Last Synced: 2025-04-06T15:56:35.601Z (about 1 year ago)
- Topics: cli, daily, log, notes, productivity, tool
- Language: Python
- Homepage: https://pypi.org/project/pynotes/
- Size: 13.7 KB
- Stars: 7
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# pynotes
[](https://pypi.org/project/pynotes/)
> Create daily notes/log with markdown.
## How to install
Verify if you have [python 3.x](https://www.python.org/downloads/) and [pip](https://pypi.org/project/pip/) installed.
```sh
$ python3 -m pip install pynotes
```
## Usage
*Show this help message and exit*
```sh
$ pynotes -h
```
*Optional arguments*
Short argument | Argument | Description |
:------------ | :----------- | :----------- |
-h | --help | Show this help message and exit
-nf | --new_file | Create a note file
-al | --add_link | Add a new link
-at | --add_tag | Add a new tag
-r | --read | Read note file and show
-l | --links | Get all links and show
-t | --tags | Get all tags and show
## Example note file
`23-07-2018.md`
```
# Notes: 23-07-2018
> Tags: `python`, `cli`, `pip`, `html`
## Links:
- [Link 1](#url1)
- [Link 2](#url2)
- [Link 3](#url3)
```
## Development
### Dev environment
1 - Install the [virtualenv](https://virtualenv.pypa.io/en/stable/)
```
$ pip install virtualenv
```
2 - Create new python environment
```
$ sh setup_env.sh
```
3 - Start the environment
```
$ source bin/activate
```
**TIP:** Type `deactivate` to close the virtualenv
### Publish
Install locally with pip
```
$ sh publish_local.sh
```
Publish in PyPi
```
$ sh publish_pypi.sh
```
## Versioning
To keep better organization of releases we follow the [Semantic Versioning 2.0.0](http://semver.org/) guidelines.
## Contributing
Find on our [issues](https://github.com/afonsopacifer/pynotes/issues/) the next steps of the project ;)
Want to contribute? [Follow these recommendations](https://github.com/afonsopacifer/pynotes/blob/master/CONTRIBUTING.md).
## History
See [Releases](https://github.com/afonsopacifer/pynotes/releases) for detailed changelog.
## License
[MIT License](https://github.com/afonsopacifer/pynotes/blob/master/LICENSE.md) © [Afonso Pacifer](https://afonsopacifer.github.io/)