Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Finalizing v0.1.6 release #23

Merged
merged 28 commits into from
Jul 14, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
6f2c48b
update project_gdf
knaaptime Jun 30, 2020
38bdbb0
bump min geopandas
knaaptime Jun 30, 2020
0b39668
Updating travis script
smmaurer Jul 8, 2020
92c02a0
Pinning pytest-cov
smmaurer Jul 8, 2020
902042c
Pycodestyle fixes
smmaurer Jul 8, 2020
122b96d
Updating versions and dates
smmaurer Jul 8, 2020
8aaccc0
Removing ez_setup
smmaurer Jul 8, 2020
94a1a9d
Updating contribution info
smmaurer Jul 8, 2020
db99da8
Dropping python 2.7
smmaurer Jul 8, 2020
2675cf0
Updating doc instructions
smmaurer Jul 8, 2020
e7d707f
Typo in readme
smmaurer Jul 8, 2020
dd2fee6
Merge pull request #21 from knaaptime/project_fix
smmaurer Jul 9, 2020
0cc43ff
Merge branch 'dev' into release-prep
smmaurer Jul 9, 2020
f74b183
Additional merge conflict resolutions
smmaurer Jul 9, 2020
d9711e5
Adding version info to docs
smmaurer Jul 9, 2020
2c3dd86
Reverting broken code formatting
smmaurer Jul 9, 2020
3442a32
Removing f-string for py35
smmaurer Jul 9, 2020
839aaed
New appveyor script
smmaurer Jul 9, 2020
0008df0
Better channel resolution
smmaurer Jul 10, 2020
1ce4097
Downgrading appveyor python
smmaurer Jul 10, 2020
c67236a
Appveyor script fix
smmaurer Jul 10, 2020
52a2c77
Changelog and versions
smmaurer Jul 10, 2020
e682f11
Checking simpler conda command
smmaurer Jul 10, 2020
667cfb0
Cleanup
smmaurer Jul 10, 2020
a2d7855
Updating doc build
smmaurer Jul 10, 2020
1c85c8e
Updated installation instructions
smmaurer Jul 13, 2020
4393b76
Merge pull request #22 from UDST/release-prep
smmaurer Jul 13, 2020
ccad564
Replacing coverage settings
smmaurer Jul 14, 2020
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .coveragerc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[run]
omit =
osmnet/**/tests/*
osmnet/tests/*
*/__init__.py
12 changes: 3 additions & 9 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,15 +1,10 @@
language: python

python:
- '2.7'
- '3.5'
- '3.6'

matrix:
include:
- python: "3.7" # temp solution to test in python 3.7
dist: xenial
sudo: true
- '3.7'
- '3.8'

install:
- pip install .
Expand All @@ -18,9 +13,8 @@ install:
- pip show osmnet

script:
- pycodestyle osmnet
- pycodestyle --max-line-length=100 osmnet
- py.test --cov osmnet --cov-report term-missing

after_success:
- coveralls
- bin/build_docs.sh
8 changes: 8 additions & 0 deletions HISTORY.rst → CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
v0.1.6
======

2020/7/13

* adds support for GeoPandas v0.7 and later
* ends support for Python 2.7 and Win32

v0.1.5
======

Expand Down
48 changes: 46 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,56 @@
#### If you have found an error:
## If you have found an error:

- check the error message and [documentation](https://udst.github.io/osmnet/index.html)
- search the previously opened and closed issues to see if the problem has already been reported
- if the problem is with a dependency of OSMnet, please open an issue on the dependency's repo
- if the problem is with OSMnet and you think you may have a fix, please submit a PR, otherwise please open an issue in the [issue tracker](https://github.com/UDST/osmnet/issues) following the issue template

#### Making a feature proposal or contributing code:
## Making a feature proposal or contributing code:

- post your requested feature on the [issue tracker](https://github.com/UDST/osmnet/issues) and mark it with a `New feature` label so it can be reviewed
- fork the repo, make your change (your code should attempt to conform to OSMnet's existing coding, commenting, and docstring styles), add new or update [unit tests](https://github.com/UDST/osmnet/tree/master/osmnet/tests), and submit a PR
- respond to the code review
## Updating the documentation:

- See instructions in `docs/README.md`


## Preparing a release:

- Make a new branch for release prep

- Update the version number and changelog
- `CHANGELOG.md`
- `setup.py`
- `osmnet/__init__.py`
- `docs/source/index.rst`

- Make sure all the tests are passing, and check if updates are needed to `README.md` or to the documentation

- Open a pull request to the master branch to finalize it

- After merging, tag the release on GitHub and follow the distribution procedures below


## Distributing a release on PyPI (for pip installation):

- Register an account at https://pypi.org, ask one of the current maintainers to add you to the project, and `pip install twine`

- Check out the copy of the code you'd like to release

- Run `python setup.py sdist bdist_wheel --universal`

- This should create a `dist` directory containing two package files -- delete any old ones before the next step

- Run `twine upload dist/*` -- this will prompt you for your pypi.org credentials

- Check https://pypi.org/project/osmnet/ for the new version


## Distributing a release on Conda Forge (for conda installation):

- The [conda-forge/osmnet-feedstock](https://github.com/conda-forge/osmnet-feedstock) repository controls the Conda Forge release

- Conda Forge bots usually detect new releases on PyPI and set in motion the appropriate feedstock updates, which a current maintainer will need to approve and merge

- Check https://anaconda.org/conda-forge/osmnet for the new version (may take a few minutes for it to appear)
2 changes: 1 addition & 1 deletion LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
GNU AFFERO GENERAL PUBLIC LICENSE
Version 3, 19 November 2007

Copyright (C) 2017 UrbanSim Inc.
Copyright (C) 2020 UrbanSim Inc.

Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Expand Down
2 changes: 1 addition & 1 deletion MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# files to include in the source distribution on pypi (setup and README are included automatically)

include HISTORY.rst
include CHANGELOG.rst
include LICENSE.txt
6 changes: 1 addition & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,11 +59,7 @@ OSMnet can be installed via PyPI:
Development Installation
^^^^^^^^^^^^^^^^^^^^^^^^

To install use the ``develop`` command rather than ``install``. Make sure you
are using the latest version of the code base by using git’s ``git pull``
inside the cloned repository.

To install OSMnet follow these steps:
To install OSMnet from source code, follow these steps:

1. Git clone the `OSMnet repo`_
2. in the cloned directory run: ``python setup.py develop``
Expand Down
35 changes: 13 additions & 22 deletions appveyor.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,33 +2,24 @@ build: false

environment:
matrix:
- PYTHON_VERSION: 2.7
MINICONDA: C:\Miniconda
- PYTHON_VERSION: 3.5
MINICONDA: C:\Miniconda3
- PYTHON: 3.6

init:
- "ECHO %PYTHON_VERSION% %MINICONDA%"
- "ECHO %PYTHON%"

# The goal here is to make sure updates to OSMnet don't introduce any Windows-specific
# runtime errors; the Travis tests running in Linux are more comprehensive. Dependencies
# are installed manually here because the shapely/geopandas stack doesn't install well
# via Pip on Windows. Only using one Python version because AppVeyor builds don't run in
# parallel and can be slow.

install:
- "set PATH=%MINICONDA%;%MINICONDA%\\Scripts;%PATH%"
- conda config --set always_yes yes --set changeps1 no
- conda update -q conda
- conda info -a
- "conda create -q -n test-environment python=%PYTHON_VERSION% numpy pandas pytest pyyaml"
- activate test-environment
- conda install -c conda-forge shapely geopandas
- pip install pycodestyle
- "set PATH=C:\\Miniconda36-x64;C:\\Miniconda36-x64\\Scripts;%PATH%"
- conda config --append channels conda-forge
- "conda create --name test-env python=%PYTHON% pip geopandas numpy pandas pytest requests shapely --yes --quiet"
- activate test-env
- pip install .
- pip install wheel
- conda list

test_script:
- pycodestyle osmnet
- py.test

after_test:
- "python.exe setup.py bdist_wheel"

artifacts:
# bdist_wheel puts your built wheel in the dist directory
- path: dist\*
59 changes: 0 additions & 59 deletions bin/build_docs.sh

This file was deleted.

20 changes: 0 additions & 20 deletions docs/Makefile

This file was deleted.

31 changes: 31 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
This folder generates the OSMNet online documentation, hosted at https://udst.github.io/osmnet/.

### How it works

HTML files are generated using [Sphinx](http://sphinx-doc.org) and hosted with GitHub Pages from the `gh-pages` branch of the repository. The online documentation is rendered and updated **manually**.

### Editing the documentation

The files in `docs/source`, along with docstrings in the source code, determine what appears in the rendered documentation. Here's a [good tutorial](https://pythonhosted.org/an_example_pypi_project/sphinx.html) for Sphinx.

### Previewing changes locally

Install the copy of OSMNet that the documentation is meant to reflect. Install the documentation tools.

```
pip install .
pip install sphinx sphinx_rtd_theme numpydoc
```

Build the documentation. There should be status messages and warnings, but no errors.

```
cd docs
sphinx-build -b html source build
```

The HTML files will show up in `docs/build/`.

### Uploading changes

Clone a second copy of the repository and check out the `gh-pages` branch. Copy over the updated HTML files, commit them, and push the changes to GitHub.
1 change: 1 addition & 0 deletions docs/build/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*/*
36 changes: 0 additions & 36 deletions docs/make.bat

This file was deleted.

6 changes: 3 additions & 3 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@
source_suffix = '.rst'
master_doc = 'index'
project = u'OSMnet'
copyright = u'2019, UrbanSim Inc.'
copyright = u'2020, UrbanSim Inc.'
author = u'UrbanSim Inc.'
version = u'0.1.5'
release = u'0.1.5'
version = u'0.1.6'
release = u'0.1.6'
language = None

nitpicky = True
Expand Down
2 changes: 2 additions & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ OSMnet

Tools for the extraction of `OpenStreetMap`_ (OSM) street network data. Intended to be used in tandem with `Pandana`_ and `UrbanAccess`_ libraries to extract street network nodes and edges.

v0.1.6, released July 13, 2020.

Contents
--------

Expand Down
Loading