Skip to content

Commit

Permalink
Add warning that running tests will delete cards
Browse files Browse the repository at this point in the history
Add a warning to the README that running the tests will delete all cards on the board `TRELLO_TEST_BOARD_NAME`.

For some people, this might be surprising. In the end a refactoring of the tests to not do that would probably be the best.
  • Loading branch information
AlexanderLill authored Sep 4, 2018
1 parent 7573739 commit 4335327
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,8 @@ To run the tests, run ``python -m unittest discover``. Four environment variable
* ``TRELLO_TEST_BOARD_COUNT``: the number of boards in your Trello account
* ``TRELLO_TEST_BOARD_NAME``: name of the board to test card manipulation on. Must be unique, or the first match will be used

*WARNING*: The tests will delete all cards on the board called `TRELLO_TEST_BOARD_NAME`!

To run tests across various Python versions,
`tox <https://tox.readthedocs.io/en/latest/>`_ is supported. Install it
and simply run ``tox`` from the ``py-trello`` directory.

0 comments on commit 4335327

Please sign in to comment.