Skip to content

Commit 503037f

Browse files
authored
Merge pull request #17 from csurfer/circleci_fix
Add CI workflow.
2 parents 7898e3f + 08a9b14 commit 503037f

File tree

16 files changed

+138
-39
lines changed

16 files changed

+138
-39
lines changed

.circleci/config.yml

Lines changed: 0 additions & 14 deletions
This file was deleted.

.coveragerc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
[report]
2-
omit = */pypette/__version__.py
1+
[run]
2+
include = pypette/*

.github/OWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
csurfer

.github/workflows/pytest.yml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Python package
2+
3+
on:
4+
- push
5+
- pull_request
6+
7+
jobs:
8+
build:
9+
10+
runs-on: ubuntu-latest
11+
strategy:
12+
matrix:
13+
python-version: [3.6, 3.7, 3.8, 3.9]
14+
15+
steps:
16+
- uses: actions/checkout@v2
17+
- name: Set up Python ${{ matrix.python-version }}
18+
uses: actions/setup-python@v2
19+
with:
20+
python-version: ${{ matrix.python-version }}
21+
- name: Install dependencies
22+
run: |
23+
python -m pip install --upgrade pip
24+
pip install pre-commit
25+
pip install -r requirements.txt
26+
pip install tox pytest
27+
- name: Lint with pre-commit
28+
run: pre-commit run --all-files
29+
- name: Testing on python ${{ matrix.python-version }} with tox
30+
run: tox -e py

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,5 @@ dist/
66
*.egg
77
*.egg-info/
88
.tox/
9+
.coverage
10+
htmlcov/

.travis.yml

Lines changed: 0 additions & 14 deletions
This file was deleted.

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,17 @@ reporting bugs or feature requests.
212212

213213
### Development
214214

215-
Pull requests are most welcome.
215+
Pull requests are most welcome. Kindly follow the steps suggested below:
216+
217+
1. Checkout the repository.
218+
2. Make your changes and add/update relavent tests.
219+
3. Install `poetry` using `pip install poetry`.
220+
4. Run `poetry install` to create project's virtual environment.
221+
5. Run tests using `poetry run tox` (Any python versions which you don't have checked out will fail this). Fix failing tests and repeat.
222+
6. Make documentation changes that are relavant.
223+
7. Install `pre-commit` using `pip install pre-commit` and run `pre-commit run --all-files` to do lint checks.
224+
8. Generate documentation using `poetry run sphinx-build -b html docs/ docs/_build/html`.
225+
9. Commit the changes and raise a pull request.
216226

217227
### Buy the developer a cup of coffee!
218228

43 Bytes
Binary file not shown.
4.46 KB
Binary file not shown.

docs/_build/html/_modules/pypette/threadwrapper.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ <h1>Source code for pypette.threadwrapper</h1><div class="highlight"><pre>
8383
<span class="kn">import</span> <span class="nn">subprocess</span>
8484
<span class="kn">from</span> <span class="nn">enum</span> <span class="kn">import</span> <span class="n">Enum</span>
8585
<span class="kn">from</span> <span class="nn">threading</span> <span class="kn">import</span> <span class="n">Thread</span>
86-
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">Union</span><span class="p">,</span> <span class="n">cast</span>
86+
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Optional</span>
8787

8888
<span class="kn">from</span> <span class="nn">.jobs</span> <span class="kn">import</span> <span class="n">BashJob</span><span class="p">,</span> <span class="n">Job</span>
8989

0 commit comments

Comments
 (0)