https://github.com/clamytoe/note
Note taking utility
https://github.com/clamytoe/note
Last synced: 9 days ago
JSON representation
Note taking utility
- Host: GitHub
- URL: https://github.com/clamytoe/note
- Owner: clamytoe
- License: mit
- Created: 2018-09-12T18:39:02.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-10-10T14:57:01.000Z (over 7 years ago)
- Last Synced: 2025-03-01T21:48:08.937Z (over 1 year ago)
- Language: Python
- Size: 32.2 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Note taking utility (*note*)
> *Facilitates with jotting down what you've done or learned each day.*
![Python version][python-version]
![Latest version][latest-version]
[![Build Status][travis-image]][travis-url]
[![BCH compliance][bch-image]][bch-url]
[![GitHub issues][issues-image]][issues-url]
[![GitHub forks][fork-image]][fork-url]
[![GitHub Stars][stars-image]][stars-url]
[![License][license-image]][license-url]
NOTE: This app was generated with [Cookiecutter](https://github.com/audreyr/cookiecutter) along with [@clamytoe's](https://github.com/clamytoe) [toepack](https://github.com/clamytoe/toepack) project template.
This project is still in very active development and is not ready to be used just yet.
### Initial setup
```bash
cd Projects
git clone https://github.com/clamytoe/note.git
cd note
```
#### Anaconda setup
If you are an Anaconda user, this command will get you up to speed with the base installation.
```bash
conda env create
conda activate note
```
#### Regular Python setup
If you are just using normal Python, this will get you ready, but I highly recommend that you do this in a virtual environment. There are many ways to do this, the simplest using *venv*.
```bash
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
```
#### Final setup
```bash
pip install -e .
```
## Usage
```bash
note
usage: note [-h] {add,delete,edit,show,stats} ...
Note Taking Utility
optional arguments:
-h, --help show this help message and exit
commands:
valid commands
{add,delete,edit,show,stats}
additional help available for each
```
## Contributing
Contributions are very welcome. Tests can be run with with `pytest -v`, please ensure that all tests are passing and that you've checked your code with the following packages before submitting a pull request:
* black
* isort
* mypy
* pytest-cov
I am not adhering to them strictly, but try to clean up what's reasonable.
## License
Distributed under the terms of the [MIT](https://opensource.org/licenses/MIT) license, "note" is free and open source software.
## Issues
If you encounter any problems, please [file an issue](https://github.com/clamytoe/toepack/issues) along with a detailed description.
## Changelog
* **v0.1.1** Workable version.
* **v0.1.0** Initial commit.
[python-version]:https://img.shields.io/badge/python-3.7-brightgreen.svg
[latest-version]:https://img.shields.io/badge/version-0.1.1-blue.svg
[travis-image]:https://travis-ci.org/clamytoe/note.svg?branch=master
[travis-url]:https://travis-ci.org/clamytoe/note
[bch-image]:https://bettercodehub.com/edge/badge/clamytoe/note?branch=master
[bch-url]:https://bettercodehub.com/
[issues-image]:https://img.shields.io/github/issues/clamytoe/note.svg
[issues-url]:https://github.com/clamytoe/note/issues
[fork-image]:https://img.shields.io/github/forks/clamytoe/note.svg
[fork-url]:https://github.com/clamytoe/note/network
[stars-image]:https://img.shields.io/github/stars/clamytoe/note.svg
[stars-url]:https://github.com/clamytoe/note/stargazers
[license-image]:https://img.shields.io/github/license/clamytoe/note.svg
[license-url]:https://github.com/clamytoe/note/blob/master/LICENSE