diff --git a/.readthedocs.yml b/.readthedocs.yml index ea3dd1d..4ce930d 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -10,7 +10,7 @@ sphinx: configuration: docs/source/conf.py # fail_on_warning might generate hard to fix error, in this case it can be # disabled but this also means those errors will fail silently, choose wisely. - fail_on_warning: false + fail_on_warning: true # Build documentation with MkDocs #mkdocs: diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst deleted file mode 100644 index 406e43c..0000000 --- a/CONTRIBUTING.rst +++ /dev/null @@ -1,128 +0,0 @@ -.. highlight:: shell - -============ -Contributing -============ - -Contributions are welcome, and they are greatly appreciated! Every little bit -helps, and credit will always be given. - -You can contribute in many ways: - -Types of Contributions ----------------------- - -Report Bugs -~~~~~~~~~~~ - -Report bugs at https://github.com/bird-house/emu/issues. - -If you are reporting a bug, please include: - -* Your operating system name and version. -* Any details about your local setup that might be helpful in troubleshooting. -* Detailed steps to reproduce the bug. - -Fix Bugs -~~~~~~~~ - -Look through the GitHub issues for bugs. Anything tagged with "bug" and "help -wanted" is open to whoever wants to implement it. - -Implement Features -~~~~~~~~~~~~~~~~~~ - -Look through the GitHub issues for features. Anything tagged with "enhancement" -and "help wanted" is open to whoever wants to implement it. - -Write Documentation -~~~~~~~~~~~~~~~~~~~ - -Emu could always use more documentation, whether as part of the -official Emu docs, in docstrings, or even on the web in blog posts, -articles, and such. - -Submit Feedback -~~~~~~~~~~~~~~~ - -The best way to send feedback is to file an issue at https://github.com/bird-house/emu/issues. - -If you are proposing a feature: - -* Explain in detail how it would work. -* Keep the scope as narrow as possible, to make it easier to implement. -* Remember that this is a volunteer-driven project, and that contributions - are welcome :) - -Get Started! ------------- - -Ready to contribute? Here's how to set up `emu` for local development. - -1. Fork the `emu` repo on GitHub. -2. Clone your fork locally:: - - $ git clone git@github.com:your_name_here/emu.git - -3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:: - - $ mkvirtualenv emu - $ cd emu/ - $ python setup.py develop - -4. Create a branch for local development:: - - $ git checkout -b name-of-your-bugfix-or-feature - - Now you can make your changes locally. - -5. When you're done making changes, check that your changes pass flake8 and the - tests, including testing other Python versions with tox:: - - $ flake8 emu tests - $ python setup.py test or pytest - $ tox - - To get flake8 and tox, just pip install them into your virtualenv. - -6. Commit your changes and push your branch to GitHub:: - - $ git add . - $ git commit -m "Your detailed description of your changes." - $ git push origin name-of-your-bugfix-or-feature - -7. Submit a pull request through the GitHub website. - -Pull Request Guidelines ------------------------ - -Before you submit a pull request, check that it meets these guidelines: - -1. The pull request should include tests. -2. If the pull request adds functionality, the docs should be updated. Put - your new functionality into a function with a docstring, and add the - feature to the list in README.rst. -3. The pull request should work for Python 3.5, 3.6, 3.7 and 3.8, and for PyPy. Check - https://travis-ci.com/bird-house/emu/pull_requests - and make sure that the tests pass for all supported Python versions. - -Tips ----- - -To run a subset of tests:: - -$ pytest tests.test_emu - - -Deploying ---------- - -A reminder for the maintainers on how to deploy. -Make sure all your changes are committed (including an entry in HISTORY.rst). -Then run:: - -$ bump2version patch # possible: major / minor / patch -$ git push -$ git push --tags - -Travis will then deploy to PyPI if tests pass. diff --git a/requirements_dev.txt b/requirements_dev.txt index 4f2deaf..450752c 100644 --- a/requirements_dev.txt +++ b/requirements_dev.txt @@ -1,5 +1,4 @@ pytest>=6.0 -pytest-runner pytest-cov flake8 tox @@ -10,8 +9,7 @@ nbsphinx nbval>=0.9.6 nbconvert sphinx>=1.8.5 -bump2version -Click +bump-my-version cruft # Changing dependencies above this comment will create merge conflicts when updating the cookiecutter template with cruft. Add extra requirements below this line. locust diff --git a/tests/test_emu.py b/tests/test_emu.py deleted file mode 100644 index 299df3a..0000000 --- a/tests/test_emu.py +++ /dev/null @@ -1,26 +0,0 @@ -#!/usr/bin/env python - -"""Tests for `emu` package.""" - -import pytest - -from click.testing import CliRunner - -import emu -from emu import cli - - -@pytest.fixture -def response(): - """Sample pytest fixture. - - See more at: http://doc.pytest.org/en/latest/fixture.html - """ - # import requests - # return requests.get('https://github.com/audreyr/cookiecutter-pypackage') - - -def test_content(response): - """Sample pytest test function with the pytest fixture as an argument.""" - # from bs4 import BeautifulSoup - # assert 'GitHub' in BeautifulSoup(response.content).title.string diff --git a/tox.ini b/tox.ini deleted file mode 100644 index f7f74ef..0000000 --- a/tox.ini +++ /dev/null @@ -1,28 +0,0 @@ -[tox] -envlist = py38, py39, flake8 -requires = pip >= 20.0 -opts = -v - -[travis] -python = - 3.9: py39 - 3.8: py38 - -[testenv:flake8] -basepython = python -deps = flake8 -commands = flake8 emu tests - -[testenv] -setenv = - PYTHONPATH = {toxinidir} -install_command = python -m pip install --no-user {opts} {packages} -download = True -deps = - -r{toxinidir}/requirements_dev.txt -; If you want to make tox run the tests with the same versions, create a -; requirements.txt with the pinned versions and uncomment the following line: -; -r{toxinidir}/requirements.txt -commands = - pytest --basetemp={envtmpdir} -