Skip to content

Commit

Permalink
[WIP] Migrate to GitHub Actions for testing (#64)
Browse files Browse the repository at this point in the history
* adding ci/ env .yml files

* adding unittests.yml

* adding .coveragerc

* updating ci/ env .yml files

* updating ci/ env .yml files [2]

* updating/alphabetizing requirements*.txt

* blackening and updating setup.py

* removing .travis.yml

* updating README.md

* removing opencv-contrib-python from envs and reqs

* adding opencv-contrib-python back to envs and reqs

* reorganzing requirements* files

* updating ci/ env .yml files [3]

* test only 3.7 and 3.8 per 665147059

* adding pygeos to 3.7 ci (mistakening left off)

* test 3.6, 3.7, 3.8 w/o Ubuntu

* test 3.6, 3.7, 3.8 only windows

* adding back all testing schemata

* update conda setup

* unittest typo [1]

* update CI workflow

* correct syntax

* correct syntax [2]

* remove doctests

* defer to newer structure

* add config for coverge in CI
  • Loading branch information
jGaboardi authored Feb 27, 2023
1 parent 6723b40 commit f70619f
Show file tree
Hide file tree
Showing 5 changed files with 42 additions and 22 deletions.
30 changes: 30 additions & 0 deletions .coveragerc
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# .coveragerc to control coverage.py
[run]
branch = True
source = pointpats

[report]
# Regexes for lines to exclude from consideration
exclude_lines =
# Have to re-enable the standard pragma
pragma: no cover

# Don't complain about missing debug-only code:
def __repr__
if self\.debug

# Don't complain if tests don't hit defensive assertion code:
raise AssertionError
raise NotImplementedError

# Don't complain if non-runnable code isn't run:
if 0:
if __name__ == .__main__.:

ignore_errors = True
omit =
*/tests/*
*__init__.py

[html]
directory = coverage_html_report
2 changes: 1 addition & 1 deletion .github/workflows/tests.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ jobs:

- name: Test pointpats
run: |
pytest -v --color yes --cov pointpats --cov-append --cov-report term-missing --cov-report xml .
pytest -v --color yes --cov pointpats --cov-config .coveragerc --cov-append --cov-report term-missing --cov-report xml .
- uses: codecov/codecov-action@v3

Expand Down
27 changes: 10 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
pointpats: Point Pattern Analysis in PySAL
==========================================
# pointpats: Point Pattern Analysis in PySAL

[![image](https://api.travis-ci.org/pysal/pointpats.svg)](https://travis-ci.org/pysal/pointpats)
[![Continuous Integration](https://github.com/pysal/pointpats/actions/workflows/tests.yml/badge.svg)](https://github.com/pysal/pointpats/actions/workflows/tests.yml)
[![codecov](https://codecov.io/gh/pysal/pointpats/branch/master/graph/badge.svg)](https://codecov.io/gh/pysal/pointpats)
[![Documentation Status](https://readthedocs.org/projects/pointpats/badge/?version=latest)](https://pointpats.readthedocs.io/en/latest/?badge=latest)
[![PyPI version](https://badge.fury.io/py/pointpats.svg)](https://badge.fury.io/py/pointpats)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3265637.svg)](https://doi.org/10.5281/zenodo.3265637)
Expand All @@ -10,8 +10,7 @@ Statistical analysis of planar point patterns.

This package is part of [PySAL](https://pysal.org): The Python Spatial Analysis Library.

Introduction
------------
## Introduction

This [pointpats](https://github.com/pysal/pointpats) package is intended
to support the statistical analysis of planar point patterns.
Expand All @@ -20,14 +19,12 @@ It currently works on cartesian coordinates. Users with data in
geographic coordinates need to project their data prior to using this
module.

Documentation
-------------
## Documentation

Online documentation is available
[here](https://pointpats.readthedocs.io).

Examples
--------
## Examples

- [Basic point pattern
structure](https://github.com/pysal/pointpats/tree/master/notebooks/pointpattern.ipynb)
Expand All @@ -39,30 +36,26 @@ Examples
- [Distance based
statistics](https://github.com/pysal/pointpats/tree/master/notebooks/distance_statistics-numpy-oriented.ipynb)

Installation
------------
## Installation

Install pointpats by running:

$ pip install pointpats

Development
-----------
## Development

pointpats development is hosted on
[github](https://github.com/pysal/pointpats).

As part of the PySAL project, pointpats development follows these
[guidelines](http://pysal.org/getting_started).

Bug reports
-----------
## Bug reports

To search for or report bugs, please see pointpats'
[issues](https://github.com/pysal/pointpats/issues).

BibTeX Citation
---------------
## BibTeX Citation

```
@misc{sergio_rey_2019_3265637,
Expand Down
2 changes: 1 addition & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@ scipy>=0.11
numpy>=1.3
pandas
matplotlib
libpysal>=4.0.0
libpysal>=4.0.0
3 changes: 0 additions & 3 deletions requirements_docs.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
sphinx
sphinxcontrib-bibtex==2.2.0
sphinx_bootstrap_theme
numpydoc
nbsphinx
matplotlib

0 comments on commit f70619f

Please sign in to comment.