Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mareksuchanek/pyt-twitterwall

CTU MI-PYT project "PYT TwitterWall"
https://github.com/mareksuchanek/pyt-twitterwall

python tweets twitter

Last synced: about 2 months ago
JSON representation

CTU MI-PYT project "PYT TwitterWall"

Awesome Lists containing this project

README

        

PYT TwitterWall
===============

|license| |version| |travis| |docs|

PYT TwitterWall is simple `Python`_ powered app for displaying `Twitter`_
tweets in CLI. It has the ability to show number of queried tweets (i.e.
selected by search string) at start and then check if new tweets are publish
and display them as well. This project is created as task for subject MI-PYT,
CTU in Prague (`subject repository`_).

Documentation
-------------

Project now use `Sphinx`_ documentation:

* Read documentation online and don't bother with anything:
- `pyt-twitterwall.readthedocs.io`_
* Build HTML documentation locally:
- Install all dependencies for ``twitterwall``
- Run this commands:
::

cd docs/
pip install -r requirements.txt
make html

- Open ``docs/_build/html/index.html`` in your browser
* Run documentation tests:
- Install all dependencies for ``twitterwall``
- Run this commands:
::

cd docs/
pip install -r requirements.txt
make doctest

Authors
-------

- Marek Suchánek [`[email protected]`_]

License
-------

This project is licensed under the MIT License - see the `LICENSE`_
file for more details.

.. _Python: https://www.python.org
.. _Twitter: https://twitter.com
.. _subject repository: https://github.com/cvut/MI-PYT
.. _Sphinx: http://www.sphinx-doc.org
.. _pyt-twitterwall.readthedocs.io: http://pyt-twitterwall.readthedocs.io
.. [email protected]: mailto:[email protected]
.. _LICENSE: LICENSE

.. |license| image:: https://img.shields.io/badge/license-MIT-blue.svg
:alt: License
:target: LICENSE
.. |version| image:: https://img.shields.io/badge/release-v0.5-orange.svg
:alt: Version
:target: setup.py
.. |travis| image:: https://travis-ci.org/MarekSuchanek/PYT-TwitterWall.svg?branch=master
:alt: Build Status
:target: https://travis-ci.org/MarekSuchanek/PYT-TwitterWall
.. |docs| image:: https://readthedocs.org/projects/pyt-twitterwall/badge/?version=latest
:alt: Documentation Status
:target: http://pyt-twitterwall.readthedocs.io/en/latest/?badge=latest