Skip to main content

Cenotes command line application and libraries

Project description

# CENotes

[![image](https://travis-ci.org/ioparaskev/cenotes.svg?branch=master)](https://travis-ci.org/ioparaskev/cenotes)
[![Documentation
Status](https://readthedocs.org/projects/cenotes/badge/?version=latest)](https://cenotes.readthedocs.io/en/latest/?badge=latest)

**C(ryptographical) E(xpendable) Notes**

**Libraries and Command Line Interface**

- Free software: GNU General Public License v3

- [Backend & Frontend Demo](https://cenot.es)

- Source code:

- [Backend](https://github.com/ioparaskev/cenotes)
- [Frontend](https://github.com/ioparaskev/cenotes-reaction)
- [CLI and Libraries](https://github.com/ioparaskev/cenotes-cli)

- [Documentation](https://cenotes.readthedocs.io)

- [Backend Design](https://cenotes.readthedocs.io/en/latest/design.html)


## What is this?

This is a **cli and library** project to support encryption/decryption of expendable
notes

An example of a backend that uses the libraries provided here can be found at
<https://cenot.es>

## What this isn't

UI/Frontend/Backend. This is a **cli/library** project. Frontend and backend
solutions are different projects. The reason for this is to allow flexibility in
frontend / backend choice and to avoid huge bundle projects.

- A **backend** project that uses these libraries can be
found [here](https://github.com/ioparaskev/cenotes)

- A **frontend** project that communicates with the **backend** can be
found [here](https://github.com/ioparaskev/cenotes-reaction)

## Features

- Symmetric encryption of notes using the
[pynacl](https://pynacl.readthedocs.io/en/latest/) project

## How does this work?

See [design](https://cenotes.readthedocs.io/en/latest/design.html)

## How to run
**You will need python >= 3.3**

1. Cloning the repo
- Clone the repo
- `git clone https://github.com/ioparaskev/cenotes-cli.git`
- Install the requirements with pipenv
- `pip install pipenv`
- `pipenv install`
- Set your `PYTHONPATH` to include the project
- For linux: `export PYTHONPATH=<path-to-the-cloned-repo>:$PYTHONPATH`
- See available options
- `python cenotes_cli/cli.py --help`
2. Installing the python package
- Ideally inside a virtualenv
- `pip install cenotes-cli`
- See available options
- `cenotes-cli --help`


=======
History
=======

0.1.0 (2017-11-29)
------------------

* First release on PyPI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for cenotes-cli, version 0.1.1
Filename, size File type Python version Upload date Hashes
Filename, size cenotes_cli-0.1.1.tar.gz (8.7 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page