Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ pip3 install OWSLib

### Dependencies

Dependencies are listed in [requirements.txt](requirements.txt). Dependencies
Dependencies are listed in [pyproject.toml](pyproject.toml). Dependencies
are automatically installed during OWSLib installation.

### Installing OWSLib
Expand Down
43 changes: 37 additions & 6 deletions docs/source/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,45 @@ You can find out about software metrics at the OWSLib OpenHub page at https://ww
Testing
-------

Create a virtual environment and install OWSLib with the development dependencies:

.. code-block:: bash

# install requirements
pip3 install -r requirements.txt
pip3 install -r requirements-dev.txt # needed for tests only
python3 -m venv owslibenv
source owslibenv/bin/activate

git clone https://github.com/geopython/OWSLib.git
cd OWSLib

pip install -e ".[dev]"

Run the test suite:

.. code-block:: bash

# run tests
python3 -m pytest

# linting
flake8 owslib/wmts.py
Run linting:

.. code-block:: bash

flake8 owslib/

Documentation
-------------

To build the documentation locally:

.. code-block:: bash

pip install -e ".[docs]"
cd docs && make html

Release
-------

To install the release tooling:

.. code-block:: bash

pip install -e ".[release]"
Loading