Skip to content
This repository has been archived by the owner. It is now read-only.
[experimental project] An accessible and customisable Twitter client
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
pardal
tests
.env.sample
.flaskenv
.gitignore
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE
Makefile
README.md
azure-pipelines.yml
keyboard.ini.sample
pardal.spec
requirements.txt
requirements_test.txt
setup.py
xvfb.init

README.md

Pardal

An acessible and customizable Twitter client

Build Status

Using it (Proof of Concept yet)

This is a proof of concept. It means that this project is experimental and currently is testing what is possible to be done. Don't expect much. :) Feel free to contribute on coding or testing it.

Run pardal executable as administrator. You can configure your keyboard editing the file keyboard.ini.

Errors should be logged on pardal.log (available on same folder as the executable file).

  • Supported Systems
  • Linux (Antergos)
  • MacOS (HighSierra)
  • Windows (Win 10)

Development

Requirements:

  • Python 3.7

IMPORTANT: Pardal must be running using sudo/administrator mode.

Virtual environment (optional)

We recommend using a virtual environment:

python -m venv venv

source venv/bin/activate

Environment variables (optional)

You must be able of testing it without any problems even if no consumer key or secret are filled in.

If you'd like to test it using real data copy .env.sample to .env and replace with the values of a Twitter APP.

export CONSUMER_KEY=xxxx
export CONSUMER_SECRET=eeee
export FAKE_TWITTER_API=False  # default: True

Dependencies

Some dependencies are specific of each operating system.

Install the general dependencies:

make install

You must install python-espeak or espeak on our OS as well.

  • Linux

sudo apt-get install -y espeak

  • MacOs

brew install espeak pip install -U pyobjc

  • Windows

pip install -U pypiwin32

Initializing the database

Init the db:

make init-db

Running the services

Run final piece of Pardal:

sudo make run

TODO

Troubleshooting

  • OSError: libespeak.so.1: cannot open shared object file: No such file or directory

You must install python-espeak or espeak on our OS.

  • ModuleNotFound error on MacOS?

Check your PYTHONPATH configuration. How to solve it here.

  • pyconfig.h could not be extracted! on MacOS?
../../../include/python3.7m/pyconfig.h could not be extracted!
fopen: No such file or directory

Try to run the executable as sudo.

You can’t perform that action at this time.