1
0
Fork 0
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
André Jaenisch e2dca69185
Switch gradually to Tkinter
6 months ago
crimpy Switch gradually to Tkinter 6 months ago
docs Basic Sphinx setup 2 years ago
resources Read Tweets from JSON 2 years ago
test Setup basic test check and test runner 2 years ago
.gitignore Connect Qt with SQLite via Pony. Switch to TableView 2 years ago
LICENSE.txt Basic example on how to turn a list of dicts into a ListView 2 years ago
README.md Unzip ZIP archive and scrub the tweet.js 2 years ago
README.rst Basic Sphinx setup 2 years ago
crimpy.pro Figure out how to translate a Qt app 2 years ago
main.py Connect Qt with SQLite via Pony. Switch to TableView 2 years ago
mypy.ini Setup basic test check and test runner 2 years ago
renovate.json Add renovate.json 2 years ago
requirements-dev.txt Add dev dependencies into separate requirements files 2 years ago
requirements-docs.txt Add dev dependencies into separate requirements files 2 years ago
requirements.txt Switch gradually to Tkinter 6 months ago
setup.cfg Setup basic test check and test runner 2 years ago
setup.py Switch gradually to Tkinter 6 months ago

README.md

crimpy

Your crispy CRM in Python

Installation

After Step 6, copy your Twitter takeout ZIP archive into the resources directory.

  1. virtualenv --python=python3 crimpy
  2. cd crimpy
  3. source bin/activate
  4. git clone https://github.com/Ryuno-Ki/crimpy.git src
  5. cd src
  6. pip install -r requirements.txt
  7. python main.py

Software documentation

This project is documented in Sphinx. To build a local version of the documentation, run this command:

pandoc README.md -o README.rst
cd docs
make html

Then open docs/_build/html/ in your webbrowser.

Testing

To run the tests with coverage reports, execute this:

pytest --cov=crimpy
coverage html  # Run in case you want to look at it

Then, check htmlcov/ for a report.

Type checks

Run the following command to check types:

mypy crimpy

Translation

In order to translate files, they need to be defined in crimpy.pro within lupdate_only as value of SOURCES. Then, run the following command to overwrite the English translation file:

lupdate crimpy/views/ -ts crimpy/languages/crimpy_en.ts

Copy that file into your target language (e.g. crimpy_de.ts) and open that file in Qt 5 Linguist.

Once the translations were finalised, compile them into a binary, so Qt can pick them up:

lrelease crimpy.pro

This will compile all *.ts files into respective *.qm files.

Data sources

Right now, this application expects you to use a Twitter takeout and place it within the resources directory (rename twitter.js to twitter.json and edit the first line to make it valid JSON).

In a future version, the application will handle the unpacking of the takeout and modifying.

License

GPL v3 or newer. See LICENSE.