-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
6927581
commit d8ee1ab
Showing
57 changed files
with
8,980 additions
and
8,980 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,47 +1,47 @@ | ||
| name: Pytest | ||
|
|
||
| on: | ||
| [push, pull_request] | ||
| env: | ||
| SETUP_XVFB: True | ||
|
|
||
| jobs: | ||
| build: | ||
|
|
||
| runs-on: ubuntu-latest | ||
| if: "!contains(github.event.head_commit.message, '[ci skip]')" | ||
|
|
||
| timeout-minutes: 60 | ||
| strategy: | ||
| matrix: | ||
| python-version: ["3.9", "3.10"] | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@master | ||
| - name: Set up Python ${{ matrix.python-version }} | ||
| uses: actions/setup-python@master | ||
| with: | ||
| python-version: ${{ matrix.python-version }} | ||
| - name: Install dependencies | ||
| run: | | ||
| python -m pip install --upgrade pip | ||
| pip install wheel flake8 pytest pytest-cov | ||
| if [ -f requirements.txt ]; then pip install -r requirements.txt; fi | ||
| pip install -e . | ||
| - name: Lint with flake8 | ||
| run: | | ||
| # stop the build if there are Python syntax errors or undefined names | ||
| flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics | ||
| # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide | ||
| flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics | ||
| - name: Test with pytest and gen report | ||
| timeout-minutes: 30 | ||
| run: | | ||
| pytest --cov=./ --cov-report=xml | ||
| - name: Upload coverage to Codecov | ||
| uses: codecov/codecov-action@v3 | ||
| with: | ||
| env_vars: OS,PYTHON | ||
| fail_ci_if_error: true | ||
| flags: unittests | ||
| name: Pytest | ||
|
|
||
| on: | ||
| [push, pull_request] | ||
| env: | ||
| SETUP_XVFB: True | ||
|
|
||
| jobs: | ||
| build: | ||
|
|
||
| runs-on: ubuntu-latest | ||
| if: "!contains(github.event.head_commit.message, '[ci skip]')" | ||
|
|
||
| timeout-minutes: 60 | ||
| strategy: | ||
| matrix: | ||
| python-version: ["3.9", "3.10"] | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@master | ||
| - name: Set up Python ${{ matrix.python-version }} | ||
| uses: actions/setup-python@master | ||
| with: | ||
| python-version: ${{ matrix.python-version }} | ||
| - name: Install dependencies | ||
| run: | | ||
| python -m pip install --upgrade pip | ||
| pip install wheel flake8 pytest pytest-cov | ||
| if [ -f requirements.txt ]; then pip install -r requirements.txt; fi | ||
| pip install -e . | ||
| - name: Lint with flake8 | ||
| run: | | ||
| # stop the build if there are Python syntax errors or undefined names | ||
| flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics | ||
| # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide | ||
| flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics | ||
| - name: Test with pytest and gen report | ||
| timeout-minutes: 30 | ||
| run: | | ||
| pytest --cov=./ --cov-report=xml | ||
| - name: Upload coverage to Codecov | ||
| uses: codecov/codecov-action@v3 | ||
| with: | ||
| env_vars: OS,PYTHON | ||
| fail_ci_if_error: true | ||
| flags: unittests | ||
| verbose: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,123 +1,123 @@ | ||
| .. 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/andreicuceu/Vega/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 | ||
| ~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| Vega could always use more documentation, whether as part of the | ||
| official Vega 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/andreicuceu/Vega/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 `Vega` for local development. | ||
|
|
||
| 1. Fork the `Vega` repo on GitHub. | ||
| 2. Clone your fork locally:: | ||
|
|
||
| $ git clone git@github.com:your_name_here/Vega.git | ||
|
|
||
| 3. Install your local copy into a conda environment following the official installation instructions | ||
|
|
||
| 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 Vega tests | ||
| $ python setup.py test or pytest | ||
|
|
||
| To get flake8, just pip install it into your conda environment. | ||
|
|
||
| 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.9 and 3.10, and for PyPy. Check | ||
| https://travis-ci.com/andreicuceu/Vega/pull_requests | ||
| and make sure that the tests pass for all supported Python versions. | ||
|
|
||
| Tips | ||
| ---- | ||
|
|
||
| To run a subset of tests:: | ||
|
|
||
| $ pytest tests.test_vega | ||
|
|
||
|
|
||
| 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. | ||
| .. 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/andreicuceu/Vega/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 | ||
| ~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| Vega could always use more documentation, whether as part of the | ||
| official Vega 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/andreicuceu/Vega/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 `Vega` for local development. | ||
|
|
||
| 1. Fork the `Vega` repo on GitHub. | ||
| 2. Clone your fork locally:: | ||
|
|
||
| $ git clone git@github.com:your_name_here/Vega.git | ||
|
|
||
| 3. Install your local copy into a conda environment following the official installation instructions | ||
|
|
||
| 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 Vega tests | ||
| $ python setup.py test or pytest | ||
|
|
||
| To get flake8, just pip install it into your conda environment. | ||
|
|
||
| 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.9 and 3.10, and for PyPy. Check | ||
| https://travis-ci.com/andreicuceu/Vega/pull_requests | ||
| and make sure that the tests pass for all supported Python versions. | ||
|
|
||
| Tips | ||
| ---- | ||
|
|
||
| To run a subset of tests:: | ||
|
|
||
| $ pytest tests.test_vega | ||
|
|
||
|
|
||
| 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. |
Oops, something went wrong.