Skip to content

Commit 08d14f7

Browse files
committed
Modify README.md
1 parent b5a3dc8 commit 08d14f7

File tree

4 files changed

+10
-10
lines changed

4 files changed

+10
-10
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ PyDriosm is an open-source tool that provides an effortless way to download and
1010

1111
## Installation
1212

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

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

2929
## License
3030

31-
- PyDriosm is licensed under [GNU General Public License v3.0](https://github.com/mikeqfu/pyhelpers/blob/master/LICENSE) or later (GPLv3+).
31+
- PyDriosm is licensed under [GNU General Public License v3.0](https://github.com/mikeqfu/pydriosm/blob/master/LICENSE) or later (GPLv3+).
3232
- 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).
3333

3434
## Acknowledgement

docs/source/installation.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Installation
33
============
44

5-
To install the latest release of pydriosm from `PyPI`_ via `pip`_:
5+
To install the latest release of PyDriosm from `PyPI`_ via `pip`_:
66

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

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

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

3636
- If using a `virtual environment`_, make sure it is activated.
3737
- 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.
38-
- 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.
38+
- 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.
3939
- For more general instructions on the installation of Python packages, please refer to the official guide of `Installing Packages`_.
4040

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

4949

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

5252
.. code-block:: python
5353
:name: cmd current version

docs/source/license.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ License
44

55
- **PyDriosm**
66

7-
- `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+).
7+
- `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+).
88

99
- **OpenStreetMap data**
1010

docs/source/quick-start.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Quick start
33
===========
44

5-
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.
5+
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.
66

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

@@ -582,7 +582,7 @@ For more details, also check out the methods :meth:`SHPReadParse.merge_shps()<py
582582
Import data into / fetch data from a PostgreSQL server
583583
======================================================
584584
585-
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.
585+
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.
586586
587587
.. _`pyhelpers.dbms.PostgreSQL`: https://pyhelpers.readthedocs.io/en/latest/_generated/pyhelpers.dbms.PostgreSQL.html
588588
.. _`PostgreSQL`: https://www.postgresql.org/
@@ -628,7 +628,7 @@ The example is illustrated in :numref:`pbf_db_example`:
628628
629629
- 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.
630630
631-
- 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.
631+
- 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.
632632
633633
- To relate the instance ``osmdb_test`` to `BBBike <https://extract.bbbike.org/>`_ data, we could just run ``osmdb.data_source = 'BBBike'``.
634634

0 commit comments

Comments
 (0)