Skip to main content

kitaab is a cli note-taking app

Project description

Python License Pypi version linting

Kitaab

Create beautiful notes right from the terminal

Screenshot 2022-06-18 at 1 11 32 AM

Publish your notes to Github

https://user-images.githubusercontent.com/90202062/181063195-b5cf53d5-f8cf-497e-8722-b3a7e586b594.mov

Install

pip install kitaab

Run

python -m kitaab

Usage

help
Screenshot 2022-06-18 at 1 21 13 AM
board
Screenshot 2022-06-18 at 1 22 01 AM

Generate token to publish notes to Github repository [OPTIONAL]

You can skip this if you don't want to publish your notes to github repository. Your notes will be safe in local sqlite3 database
Uploading notes to github requires Authentication. Thankfully, Github users can generate Tokens to access GithubApi.

You can easily generate one for yourself by following the steps below:

  1. Sign in to your Github account
  2. Go to settings
  3. Navigate to Developer settings
  4. Click on Personal access tokens
  5. Click on Generate new Token
  6. Give it a name , set expiration date and click on repo under scopes
  7. Navigate down and click on green button Generate token
  8. Make sure to copy your personal access token now, you won't be able to see it again.

Screenshot 2022-06-18 at 1 46 30 AM

How to add token

add-token
Screenshot 2022-06-18 at 2 13 21 AM

Project details


Download files

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

Source Distribution

kitaab-0.0.5.tar.gz (6.4 kB view hashes)

Uploaded Source

Built Distribution

kitaab-0.0.5-py3-none-any.whl (7.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page