Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated readme #365

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Updated readme #365

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5aadfcb
added package label
Feb 7, 2023
9a484c0
added docs reference
Feb 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
A wrapper around the Trello API written in Python. Each Trello object is
represented by a corresponding Python object. The attributes of these objects
==================================================
py-trello - A Python wrapper around the Trello API
==================================================

Each Trello object is represented by a corresponding Python object. The attributes of these objects
are cached, but the child objects are not. This can possibly be improved when
the API allows for notification subscriptions; this would allow caching
(assuming a connection was available to invalidate the cache as appropriate).
Expand Down Expand Up @@ -79,6 +82,10 @@ Run
::

python -m trello oauth

Docs
====
`Check out the docs on readthedocs <https://py-trello-dev.readthedocs.io>`_

Required Python modules
=======================
Expand Down