Merge pull request #17 from csurfer/circleci_fix

Add CI workflow.

Author: csurfer

.circleci/config.yml

@@ -1,2 +1,2 @@
-[report]
-omit = */pypette/__version__.py
+[run]
+include = pypette/*

.coveragerc

@@ -0,0 +1 @@
+csurfer

.github/OWNERS

@@ -0,0 +1,30 @@
+name: Python package
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.6, 3.7, 3.8, 3.9]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install pre-commit
+          pip install -r requirements.txt
+          pip install tox pytest
+      - name: Lint with pre-commit
+        run: pre-commit run --all-files
+      - name: Testing on python ${{ matrix.python-version }} with tox
+        run: tox -e py

.github/workflows/pytest.yml

@@ -6,3 +6,5 @@ dist/
 *.egg
 *.egg-info/
 .tox/
+.coverage
+htmlcov/

.gitignore

@@ -212,7 +212,17 @@ reporting bugs or feature requests.
 
 ### Development
 
-Pull requests are most welcome.
+Pull requests are most welcome. Kindly follow the steps suggested below:
+
+1. Checkout the repository.
+2. Make your changes and add/update relavent tests.
+3. Install `poetry` using `pip install poetry`.
+4. Run `poetry install` to create project's virtual environment.
+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.
+6. Make documentation changes that are relavant.
+7. Install `pre-commit` using `pip install pre-commit` and run `pre-commit run --all-files` to do lint checks.
+8. Generate documentation using `poetry run sphinx-build -b html docs/ docs/_build/html`.
+9. Commit the changes and raise a pull request.
 
 ### Buy the developer a cup of coffee!
 

.travis.yml

@@ -83,7 +83,7 @@ <h1>Source code for pypette.threadwrapper</h1><div class="highlight"><pre>
 <span class="kn">import</span> <span class="nn">subprocess</span>
 <span class="kn">from</span> <span class="nn">enum</span> <span class="kn">import</span> <span class="n">Enum</span>
 <span class="kn">from</span> <span class="nn">threading</span> <span class="kn">import</span> <span class="n">Thread</span>
-<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>
+<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="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>