Metadata-Version: 2.1
Name: gpf3
Version: 0.3.2
Summary: Geocom Python Framework for ArcPy (Esri ArcGIS Pro).
Home-page: https://github.com/geocom-gis/gpf3
Author: Geocom Informatik AG / VertiGIS, Burgdorf, Switzerland
Author-email: github@geocom.ch
License: Apache License 2.0
Project-URL: Source, https://github.com/geocom-gis/gpf3
Project-URL: Documentation, https://gpf3.readthedocs.io/
Keywords: Geocom,GIS,GEONIS,tools,scripting,framework,spatial,geospatial,geoprocessing,Esri,ArcGIS,ArcPy,VertiGIS
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Environment :: Other Environment
Classifier: Operating System :: Microsoft :: Windows
Classifier: Topic :: Scientific/Engineering :: GIS
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3.6
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
Provides-Extra: test
Requires-Dist: pytest ; extra == 'test'
Requires-Dist: pytest-cov ; extra == 'test'
Requires-Dist: mock ; extra == 'test'
Requires-Dist: pytest-mock ; extra == 'test'

Welcome to the Geocom Python Framework (GPF)
============================================

|build| |issues| |repo|

.. |build| image:: https://img.shields.io/appveyor/ci/geocom/gpf3?logo=appveyor
    :alt: AppVeyor
    :target: https://ci.appveyor.com/project/geocom/gpf3

.. |issues| image:: https://img.shields.io/github/issues-raw/geocom-gis/gpf3?logo=github
    :alt: GitHub issues
    :target: https://github.com/geocom-gis/gpf3/issues

.. |repo| image:: https://img.shields.io/github/repo-size/geocom-gis/gpf3
    :alt: GitHub repo size

Purpose
-------

The *Geocom Python Framework* or ``gpf`` provides a set of Python modules that contain tools, helpers, loggers etc. for a more pleasant Python scripting experience with `ArcGIS Pro`_.
GIS users who need to write geoprocessing scripts with ``arcpy`` might benefit from importing the ``gpf`` module into their script as well.

The ``gpf`` module in this repository has been developed for **Python 3.6+ (ArcGIS Pro, Server)**.
However, it is also available for Python 2.7.14+ (ArcGIS Desktop/Server) on `GitHub <https://github.com/geocom-gis/gpf>`_ and `PyPI <https://pypi.org/project/gpf>`_.

Geocom customers who need to write GEONIS menu or form scripts should be aware of the gntools_ module.
However, this module is not available for ArcGIS Pro, as it is Python 2.7 only.

.. _ArcGIS Pro: https://www.esri.com
.. _GEONIS: https://geonis.com/en/solutions/framework/geonis
.. _gntools: https://pypi.org/project/gntools

Requirements
------------

- ArcGIS Pro 2.3 or higher
- Python 3.6 or higher (along with the ``arcpy`` module)

Installation
------------

The easiest way to install the Geocom Python Framework, is to use the built-in package manager in ArcGIS Pro.
Navigate to Options > Python and select the environment in which you wish to install the ``gpf`` package.

Alternatively, you can use pip_, a Python package manager.
When ``pip`` is installed, the user can simply run:

    ``python -m pip install gpf3``

.. note::   Although the PyPI package is called ``gpf3``, the name of the import package is ``gpf``.
            This means, that you can import it into your own modules using ``import gpf``.

.. _pip: https://pip.pypa.io/en/stable/installing/

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

The complete ``gpf`` API reference can be found `here`_.

.. _here: https://geocom-gis.github.io/gpf3/

License
-------

`Apache License 2.0`_ Â© 2019 Geocom Informatik AG / VertiGIS & contributors

.. _Apache License 2.0: https://github.com/geocom-gis/gpf3/blob/master/LICENSE


