diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index c54acc75..d455bb85 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -78,10 +78,6 @@ repos: hooks: - id: mypy additional_dependencies: [pygeoif, arrow] - # - repo: https://github.com/mgedmin/check-manifest - # rev: "0.49" - # hooks: - # - id: check-manifest # - repo: https://github.com/Lucas-C/pre-commit-hooks-markup # rev: v1.0.1 # hooks: diff --git a/MANIFEST.in b/MANIFEST.in deleted file mode 100644 index 8ae540fc..00000000 --- a/MANIFEST.in +++ /dev/null @@ -1,10 +0,0 @@ -include *.rst -recursive-include docs *.txt -recursive-exclude *.pyc *.pyo -include docs LICENSE.GPL -include *.txt -recursive-include docs *.py -recursive-include docs *.rst -recursive-include docs Makefile -recursive-include tests *.py -recursive-include schema *.xsd diff --git a/README.rst b/README.rst index 48bfde94..6248b33b 100644 --- a/README.rst +++ b/README.rst @@ -1,8 +1,7 @@ Introduction ============ -KML is an XML geospatial data format and an `OGC standard `_ -that deserves a canonical python implementation. +KML is an XML geospatial data format and an OGC_ standard that deserves a canonical python implementation. Fastkml is a library to read, write and manipulate KML files. It aims to keep it simple and fast (using lxml_ if available). Fast refers to the time you @@ -97,18 +96,14 @@ Requirements ------------- * pygeoif_ -* lxml_ * arrow_ Optional --------- -* lxml_ - -You can install all of the requirements for working with FastKML by using pip_:: - - pip install -r requirements.txt +* lxml_:: + pip install --pre "fastkml[lxml]" Limitations =========== @@ -122,7 +117,7 @@ is the `gx extension `_. Please submit a PR with the features you'd like to see implemented. -.. _pygeoif: http://pypi.python.org/pypi/pygeoif/ +.. _pygeoif: https://pypi.python.org/pypi/pygeoif/ .. _lxml: https://pypi.python.org/pypi/lxml .. _arrow: https://pypi.python.org/pypi/arrow -.. _pip: https://pypi.python.org/pypi/pip +.. _OGC: https://www.ogc.org/standard/kml/ diff --git a/docs/HISTORY.txt b/docs/HISTORY.rst similarity index 97% rename from docs/HISTORY.txt rename to docs/HISTORY.rst index 5dd3b303..e5e3255c 100644 --- a/docs/HISTORY.txt +++ b/docs/HISTORY.rst @@ -9,7 +9,8 @@ Changelog - Drop shapely native support - Add type annotations - refactor - +- Use arrow instead of dateutil +- Add an informative ``__repr__`` 0.12 (2020/09/23) ----------------- diff --git a/docs/conf.py b/docs/conf.py index 5d1c1465..7f654670 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -28,7 +28,10 @@ # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = ["sphinx.ext.autodoc"] +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.doctest", +] # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] diff --git a/docs/fastkml.rst b/docs/fastkml.rst index 9d935f0a..7cc89984 100644 --- a/docs/fastkml.rst +++ b/docs/fastkml.rst @@ -100,6 +100,7 @@ fastkml.kml module :members: :undoc-members: :show-inheritance: + :no-index: StyleUrl fastkml.mixins module --------------------- diff --git a/fastkml/about.py b/fastkml/about.py index 5d5b4b67..19f2219b 100644 --- a/fastkml/about.py +++ b/fastkml/about.py @@ -3,4 +3,4 @@ The only purpose of this module is to provide a version number for the package. """ -__version__ = "1.0.a8" +__version__ = "1.0.a9" diff --git a/fastkml/py.typed b/fastkml/py.typed new file mode 100644 index 00000000..e69de29b diff --git a/pyproject.toml b/pyproject.toml index 88ef042d..cdc16411 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -94,6 +94,7 @@ keywords = [ ] [project.urls] +Changelog = "https://github.com/cleder/fastkml/blob/develop/docs/HISTORY.rst" Documentation = "https://fastkml.readthedocs.org/" Homepage = "https://github.com/cleder/fastkml" @@ -106,6 +107,15 @@ ignore = [ "tox.ini", ] +[tool.coverage.paths] +source = [ + "fastkml", + "tests", +] + +[tool.coverage.run] +branch = true + [tool.flake8] max_line_length = 89 @@ -242,6 +252,10 @@ attr = "fastkml.about.__version__" [tool.setuptools.packages.find] exclude = [ - "ez_setup", + "docs/*", +] +include = [ + "fastkml*", + "fastkml/py.typed", ] namespaces = false