Metadata-Version: 2.1
Name: mnemo
Version: 0.0.2
Summary: Notebook and assistant.
Home-page: https://github.com/ggirelli/mnemo-assistant
License: MIT
Keywords: assistant,notebook,journal,database
Author: Gabriele Girelli
Author-email: gigi.ga90@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Database
Classifier: Topic :: Database :: Front-Ends
Classifier: Topic :: Office/Business
Classifier: Topic :: Office/Business :: News/Diary
Classifier: Topic :: Office/Business :: Scheduling
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Requires-Dist: bottle (>=0.12.19,<0.13.0)
Requires-Dist: click (>=8.0.1,<9.0.0)
Requires-Dist: passlib (>=1.7.4,<2.0.0)
Requires-Dist: paste (>=3.5.0,<4.0.0)
Requires-Dist: rich (>=10.4.0,<11.0.0)
Requires-Dist: tinydb (>=4.5.0,<5.0.0)
Project-URL: Repository, https://github.com/ggirelli/mnemo-assistant
Description-Content-Type: text/markdown

# mnemo-assistant

![Release ID](https://img.shields.io/github/release/ggirelli/mnemo-assistant.svg?style=flat) ![Release date](https://img.shields.io/github/release-date/ggirelli/mnemo-assistant.svg?style=flat)  
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mnemo) ![PyPI - Status](https://img.shields.io/pypi/status/mnemo) ![GitHub Actions Python package status](https://github.com/ggirelli/mnemo-assistant/workflows/Python%20package/badge.svg?branch=main&event=push)  
![license](https://img.shields.io/github/license/ggirelli/mnemo-assistant.svg?style=flat) ![Code size](https://img.shields.io/github/languages/code-size/ggirelli/mnemo-assistant.svg?style=flat)  
![Watch no.](https://img.shields.io/github/watchers/ggirelli/mnemo-assistant.svg?label=Watch&style=social) ![Stars no.](https://img.shields.io/github/stars/ggirelli/mnemo-assistant.svg?style=social)

[PyPi](https://pypi.org/project/mnemo/) | [docs](https://ggirelli.github.io/mnemo-assistant/)

A Python3.8+ web framework providing tools for journaling and note taking.

## Features (in short)

* Bottle-based web framework.
* Login system (currently supports one user at a time).

## Requirements

`mnemo-assistant` has been tested with Python 3.8 and 3.9. We recommend installing it using `pipx` (see [below](https://github.com/ggirelli/mnemo-assistant#install)) to avoid dependency conflicts with other packages. The packages it depends on are listed in our [dependency graph](https://github.com/ggirelli/mnemo-assistant/network/dependencies). We use [`poetry`](https://github.com/python-poetry/poetry) to handle our dependencies.

## Install

We recommend installing `mnemo-assistant` using [`pipx`](https://github.com/pipxproject/pipx). Check how to install `pipx` [here](https://github.com/pipxproject/pipx#install-pipx) if you don't have it yet! Once you have `pipx` ready on your system, install the latest stable release of `mnemo-assistant` by running: `pipx install mnemo-assistant`. If you see the stars (✨ 🌟 ✨), then the installation went well!

## Usage

Run `mnemo` to access the barber's services. Add `-h` to see the full help page of a command! Also, run `mnemo-autocomplete -s BASH_TYPE` to activate autocompletion. `BASH_TYPE` currently supports: `bash`, `fish`, and `zsh`.

## Contributing

We welcome any contributions to `mnemo-assistant`. In short, we use [`black`](https://github.com/psf/black) to standardize code format. Any code change also needs to pass `mypy` checks. For more details, please refer to our [contribution guidelines](https://github.com/ggirelli/mnemo-assistant/blob/main/CONTRIBUTING.md) if this is your first time contributing! Also, check out our [code of conduct](https://github.com/ggirelli/mnemo-assistant/blob/main/CODE_OF_CONDUCT.md).

## License

`MIT License - Copyright (c) 2021 Gabriele Girelli`

