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 details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

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

Uploaded Python 3

File details

Details for the file kitaab-0.0.5.tar.gz.

File metadata

  • Download URL: kitaab-0.0.5.tar.gz
  • Upload date:
  • Size: 6.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.0

File hashes

Hashes for kitaab-0.0.5.tar.gz
Algorithm Hash digest
SHA256 9a6690a3d176e466bda369f8c14a625f5352d4983f1b0179ade80246828a4632
MD5 2e23ec7c7ee98eca4a7471507b9e7566
BLAKE2b-256 c514b8322478802abce9dac05b936f8683c196ea7ddff7ea63341a0190c31613

See more details on using hashes here.

File details

Details for the file kitaab-0.0.5-py3-none-any.whl.

File metadata

  • Download URL: kitaab-0.0.5-py3-none-any.whl
  • Upload date:
  • Size: 7.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.0

File hashes

Hashes for kitaab-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 ee3e0a16c633d1a58ce9d438775fae59165db18aa72c620e1c59a99047d45cdd
MD5 ee7702060b7254e0e95781cb5b1e36bd
BLAKE2b-256 49b11312e3d9ba003c919deb65ecb02a213934d2ab8074f6fb5cca82ce9541f3

See more details on using hashes here.

Supported by

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