Skip to content

afonsopacifer/pynotes

Repository files navigation

pynotes

PyPI

Create daily notes/log with markdown.

How to install

Verify if you have python 3.x and pip installed.

$ python3 -m pip install pynotes

Usage

Show this help message and exit

$ 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

$ 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 guidelines.

Contributing

Find on our issues the next steps of the project ;)
Want to contribute? Follow these recommendations.

History

See Releases for detailed changelog.

License

MIT License © Afonso Pacifer