Skip to content

Commit

Permalink
Modify README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mikeqfu committed Jun 19, 2023
1 parent b5a3dc8 commit 08d14f7
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 10 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ PyDriosm is an open-source tool that provides an effortless way to download and

## Installation

To install the latest release of pydriosm from [PyPI](https://pypi.org/project/pydriosm/) via [pip](https://pip.pypa.io/en/stable/cli/pip/):
To install the latest release of PyDriosm from [PyPI](https://pypi.org/project/pydriosm/) via [pip](https://pip.pypa.io/en/stable/cli/pip/):

```bash
pip install --upgrade pydriosm
Expand All @@ -28,7 +28,7 @@ The full PyDriosm documentation [[HTML](https://pydriosm.readthedocs.io/en/lates

## License

- PyDriosm is licensed under [GNU General Public License v3.0](https://github.com/mikeqfu/pyhelpers/blob/master/LICENSE) or later (GPLv3+).
- PyDriosm is licensed under [GNU General Public License v3.0](https://github.com/mikeqfu/pydriosm/blob/master/LICENSE) or later (GPLv3+).
- The free [OpenStreetMap](https://www.openstreetmap.org/) data, which is used for the development of PyDriosm, is licensed under the [Open Data Commons Open Database License](https://opendatacommons.org/licenses/odbl/) (ODbL) by the [OpenStreetMap Foundation](https://osmfoundation.org/) (OSMF).

## Acknowledgement
Expand Down
8 changes: 4 additions & 4 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Installation
============

To install the latest release of pydriosm from `PyPI`_ via `pip`_:
To install the latest release of PyDriosm from `PyPI`_ via `pip`_:

.. _`PyPI`: https://pypi.org/project/pydriosm/
.. _`pip`: https://pip.pypa.io/en/stable/cli/pip/
Expand All @@ -12,7 +12,7 @@ To install the latest release of pydriosm from `PyPI`_ via `pip`_:
pip install --upgrade pydriosm
To install the most recent version of pydriosm hosted on `GitHub`_:
To install the most recent version of PyDriosm hosted on `GitHub`_:

.. _`GitHub`: https://github.com/mikeqfu/pydriosm

Expand All @@ -35,7 +35,7 @@ To install the most recent version of pydriosm hosted on `GitHub`_:

- If using a `virtual environment`_, make sure it is activated.
- It is recommended to add `pip install`_ the option ``--upgrade`` (or ``-U``) to ensure that you are getting the latest stable release of the package.
- Non-essential dependencies (e.g. `GeoPandas`_) of pydriosm are not enforced to be installed along with the installation of the package. This is intended to optimise the installation requirements. If a `ModuleNotFoundError`_ or an `ImportError`_ pops out when importing/running a function or a method, first try to install the module(s)/package(s) mentioned in the error message, and then try to import/run the function or method again.
- Non-essential dependencies (e.g. `GeoPandas`_) of PyDriosm are not enforced to be installed along with the installation of the package. This is intended to optimise the installation requirements. If a `ModuleNotFoundError`_ or an `ImportError`_ pops out when importing/running a function or a method, first try to install the module(s)/package(s) mentioned in the error message, and then try to import/run the function or method again.
- For more general instructions on the installation of Python packages, please refer to the official guide of `Installing Packages`_.

.. _`virtual environment`: https://packaging.python.org/glossary/#term-Virtual-Environment
Expand All @@ -47,7 +47,7 @@ To install the most recent version of pydriosm hosted on `GitHub`_:
.. _`Installing Packages`: https://packaging.python.org/tutorials/installing-packages/


To check whether pydriosm has been correctly installed, try to import the package via an interpreter shell:
To check whether PyDriosm has been correctly installed, try to import the package via an interpreter shell:

.. code-block:: python
:name: cmd current version
Expand Down
2 changes: 1 addition & 1 deletion docs/source/license.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ License

- **PyDriosm**

- `pydriosm <https://pypi.org/project/pydriosm/>`_ is licensed under `GNU General Public License v3.0 <https://github.com/mikeqfu/pydriosm/blob/master/LICENSE>`_ or later (GPLv3+).
- `PyDriosm <https://pypi.org/project/pydriosm/>`_ is licensed under `GNU General Public License v3.0 <https://github.com/mikeqfu/pydriosm/blob/master/LICENSE>`_ or later (GPLv3+).

- **OpenStreetMap data**

Expand Down
6 changes: 3 additions & 3 deletions docs/source/quick-start.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Quick start
===========

For a demonstration of how `pydriosm <https://pypi.org/project/pydriosm/>`_ works with `OpenStreetMap <https://www.openstreetmap.org/>`_ (OSM) data, this section of the documentation provides a quick guide with practical examples. It showcases the usage of the package for tasks such as downloading, parsing, and storage I/O of OSM data.
For a demonstration of how `PyDriosm <https://pypi.org/project/pydriosm/>`_ works with `OpenStreetMap <https://www.openstreetmap.org/>`_ (OSM) data, this section of the documentation provides a quick guide with practical examples. It showcases the usage of the package for tasks such as downloading, parsing, and storage I/O of OSM data.

(Also check out `GitHub <https://github.com/mikeqfu/pydriosm>`_ and `Documentation <https://pydriosm.readthedocs.io/en/latest/>`_.)

Expand Down Expand Up @@ -582,7 +582,7 @@ For more details, also check out the methods :meth:`SHPReadParse.merge_shps()<py
Import data into / fetch data from a PostgreSQL server
======================================================
After downloading and reading the OSM data, `pydriosm <https://pypi.org/project/pydriosm/>`_ further provides a practical solution - the module :mod:`pydriosm.ios` - to managing the storage I/O of the data through database. Specifically, the class :class:`~pydriosm.ios.PostgresOSM`, which inherits from `pyhelpers.dbms.PostgreSQL`_, can assist us with importing the OSM data into, and retrieving it from, a `PostgreSQL`_ server.
After downloading and reading the OSM data, `PyDriosm <https://pypi.org/project/pydriosm/>`_ further provides a practical solution - the module :mod:`pydriosm.ios` - to managing the storage I/O of the data through database. Specifically, the class :class:`~pydriosm.ios.PostgresOSM`, which inherits from `pyhelpers.dbms.PostgreSQL`_, can assist us with importing the OSM data into, and retrieving it from, a `PostgreSQL`_ server.
.. _`pyhelpers.dbms.PostgreSQL`: https://pyhelpers.readthedocs.io/en/latest/_generated/pyhelpers.dbms.PostgreSQL.html
.. _`PostgreSQL`: https://www.postgresql.org/
Expand Down Expand Up @@ -628,7 +628,7 @@ The example is illustrated in :numref:`pbf_db_example`:
- The parameter ``password`` is by default ``None``. If we don't specify a password for creating an instance, we'll need to manually type in the password to the PostgreSQL server.
- The class :class:`~pydriosm.ios.PostgresOSM` incorporates the classes for downloading and reading OSM data from the modules :mod:`downloader<pydriosm.downloader>` and :mod:`reader<pydriosm.reader>` as properties. In the case of the above instance, ``osmdb.downloader`` is equivalent to the class :class:`GeofabrikDownloader<pydriosm.downloader.GeofabrikDownloader>`, as the parameter ``data_source='Geofabrik'`` by default.
- The class :class:`~pydriosm.ios.PostgresOSM` incorporates the classes for downloading and reading OSM data from the modules :mod:`~pydriosm.downloader` and :mod:`~pydriosm.reader` as properties. In the case of the above instance, ``osmdb.downloader`` is equivalent to the class :class:`~pydriosm.downloader.GeofabrikDownloader`, as the parameter ``data_source='Geofabrik'`` by default.
- To relate the instance ``osmdb_test`` to `BBBike <https://extract.bbbike.org/>`_ data, we could just run ``osmdb.data_source = 'BBBike'``.
Expand Down

0 comments on commit 08d14f7

Please sign in to comment.