tifeatures

Name	tifeatures JSON
Version	0.1.0a4 JSON
	download
home_page	None
Summary	Simple and Fast Geospatial Features API for PostGIS.
upload_time	2023-03-15 08:15:46
maintainer	None
docs_url	None
author	None
requires_python	>=3.8
license	MIT License Copyright (c) 2022 Development Seed Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords	fastapi ogc features postgis
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            <p align="center">
  <img width="500" src="https://user-images.githubusercontent.com/10407788/172736520-18da1910-87ac-41a9-b6f0-6c6ae503bd5e.png"/>
  <p align="center">Simple and Fast Geospatial Features API for PostGIS.</p>
</p>
<p align="center">
  <a href="https://github.com/developmentseed/tifeatures/actions?query=workflow%3ACI" target="_blank">
      <img src="https://github.com/developmentseed/tifeatures/workflows/CI/badge.svg" alt="Test">
  </a>
  <a href="https://codecov.io/gh/developmentseed/tifeatures" target="_blank">
      <img src="https://codecov.io/gh/developmentseed/tifeatures/branch/master/graph/badge.svg" alt="Coverage">
  </a>
  <a href="https://pypi.org/project/tifeatures" target="_blank">
      <img src="https://img.shields.io/pypi/v/tifeatures?color=%2334D058&label=pypi%20package" alt="Package version">
  </a>
  <a href="https://github.com/developmentseed/tifeatures/blob/master/LICENSE" target="_blank">
      <img src="https://img.shields.io/github/license/developmentseed/tifeatures.svg" alt="License">

  </a>
</p>

---

**Documentation**: <a href="https://developmentseed.org/tifeatures/" target="_blank">https://developmentseed.org/tifeatures/</a>

**Source Code**: <a href="https://github.com/developmentseed/tifeatures" target="_blank">https://github.com/developmentseed/tifeatures</a>

---

> :warning: This project is on pause while we focus on [`developmentseed/tipg`](https://github.com/developmentseed/tipg) :warning:
>
>  ref: https://github.com/developmentseed/timvt/discussions/96

---

`TiFeatures`, pronounced *T[ee]Features*, is a **python** package which helps creating lightweight **Features** server for PostGIS Database. The API has been designed with respect to [OGC Features API specification](https://github.com/opengeospatial/ogcapi-features).

---

## Install

```bash
$ python -m pip install pip -U
$ python -m pip install tifeatures

# or from source
$ git clone https://github.com/developmentseed/tifeatures.git
$ cd tifeatures
$ python -m pip install -e .
```

## OGC Specification

Specification | Status | link |
|          -- |     -- |   -- |
Part 1: Core             | ✅ | https://docs.ogc.org/is/17-069r4/17-069r4.html
Part 2: CRS by Reference | ❌ | https://docs.ogc.org/is/18-058r1/18-058r1.html
Part 3: Filtering / CQL2 | ✅ | https://docs.ogc.org/DRAFTS/19-079r1.html

Notes:

The project authors choose not to implement the Part 2 of the specification to avoid the introduction of CRS based GeoJSON. This might change in the future.

While the authors tried to follow the specification (part 1 and 3) to the letter, some API endpoints might have more capabilities (e.g geometry column selection).

## PostGIS/PostgreSQL

`TiFeatures` rely a lot of `ST_*` PostGIS functions. You need to make sure your PostgreSQL database has PostGIS installed.

```sql
SELECT name, default_version,installed_version
FROM pg_available_extensions WHERE name LIKE 'postgis%' or name LIKE 'address%';
```

```sql
CREATE EXTENSION postgis;
```

### Configuration

To be able to work, the application will need access to the database. `tifeatures` uses [starlette](https://www.starlette.io/config/)'s configuration pattern which make use of environment variable and/or `.env` file to pass variable to the application.

Example of `.env` file can be found in [.env.example](https://github.com/developmentseed/tifeatures/blob/master/.env.example)

```
# you need define the DATABASE_URL directly
DATABASE_URL=postgresql://username:password@0.0.0.0:5432/postgis
```

## Launch

```bash
$ pip install uvicorn

# Set your postgis database instance URL in the environment
$ export DATABASE_URL=postgresql://username:password@0.0.0.0:5432/postgis
$ uvicorn tifeatures.main:app

# or using Docker

$ docker-compose up
```

<p align="center">
  <img src="https://user-images.githubusercontent.com/10407788/199774870-2e385617-bae8-4513-9349-d97e43670767.png"/>
</p>

## Contribution & Development

See [CONTRIBUTING.md](https://github.com/developmentseed/tifeatures/blob/master/CONTRIBUTING.md)

## License

See [LICENSE](https://github.com/developmentseed/tifeatures/blob/master/LICENSE)

## Authors

Created by [Development Seed](<http://developmentseed.org>)

## Changes

See [CHANGES.md](https://github.com/developmentseed/tifeatures/blob/master/CHANGES.md).


            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "tifeatures",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "FastAPI,OGC Features,POSTGIS",
    "author": null,
    "author_email": "Vincent Sarago <vincent@developmentseed.org>, David Bitner <david@developmentseed.org>",
    "download_url": "https://files.pythonhosted.org/packages/c5/a7/05b5077a289c5c46c69780602734ef7fef0670019bdf86c623406540034c/tifeatures-0.1.0a4.tar.gz",
    "platform": null,
    "description": "<p align=\"center\">\n  <img width=\"500\" src=\"https://user-images.githubusercontent.com/10407788/172736520-18da1910-87ac-41a9-b6f0-6c6ae503bd5e.png\"/>\n  <p align=\"center\">Simple and Fast Geospatial Features API for PostGIS.</p>\n</p>\n<p align=\"center\">\n  <a href=\"https://github.com/developmentseed/tifeatures/actions?query=workflow%3ACI\" target=\"_blank\">\n      <img src=\"https://github.com/developmentseed/tifeatures/workflows/CI/badge.svg\" alt=\"Test\">\n  </a>\n  <a href=\"https://codecov.io/gh/developmentseed/tifeatures\" target=\"_blank\">\n      <img src=\"https://codecov.io/gh/developmentseed/tifeatures/branch/master/graph/badge.svg\" alt=\"Coverage\">\n  </a>\n  <a href=\"https://pypi.org/project/tifeatures\" target=\"_blank\">\n      <img src=\"https://img.shields.io/pypi/v/tifeatures?color=%2334D058&label=pypi%20package\" alt=\"Package version\">\n  </a>\n  <a href=\"https://github.com/developmentseed/tifeatures/blob/master/LICENSE\" target=\"_blank\">\n      <img src=\"https://img.shields.io/github/license/developmentseed/tifeatures.svg\" alt=\"License\">\n\n  </a>\n</p>\n\n---\n\n**Documentation**: <a href=\"https://developmentseed.org/tifeatures/\" target=\"_blank\">https://developmentseed.org/tifeatures/</a>\n\n**Source Code**: <a href=\"https://github.com/developmentseed/tifeatures\" target=\"_blank\">https://github.com/developmentseed/tifeatures</a>\n\n---\n\n> :warning: This project is on pause while we focus on [`developmentseed/tipg`](https://github.com/developmentseed/tipg) :warning:\n>\n>  ref: https://github.com/developmentseed/timvt/discussions/96\n\n---\n\n`TiFeatures`, pronounced *T[ee]Features*, is a **python** package which helps creating lightweight **Features** server for PostGIS Database. The API has been designed with respect to [OGC Features API specification](https://github.com/opengeospatial/ogcapi-features).\n\n---\n\n## Install\n\n```bash\n$ python -m pip install pip -U\n$ python -m pip install tifeatures\n\n# or from source\n$ git clone https://github.com/developmentseed/tifeatures.git\n$ cd tifeatures\n$ python -m pip install -e .\n```\n\n## OGC Specification\n\nSpecification | Status | link |\n|          -- |     -- |   -- |\nPart 1: Core             | \u2705 | https://docs.ogc.org/is/17-069r4/17-069r4.html\nPart 2: CRS by Reference | \u274c | https://docs.ogc.org/is/18-058r1/18-058r1.html\nPart 3: Filtering / CQL2 | \u2705 | https://docs.ogc.org/DRAFTS/19-079r1.html\n\nNotes:\n\nThe project authors choose not to implement the Part 2 of the specification to avoid the introduction of CRS based GeoJSON. This might change in the future.\n\nWhile the authors tried to follow the specification (part 1 and 3) to the letter, some API endpoints might have more capabilities (e.g geometry column selection).\n\n## PostGIS/PostgreSQL\n\n`TiFeatures` rely a lot of `ST_*` PostGIS functions. You need to make sure your PostgreSQL database has PostGIS installed.\n\n```sql\nSELECT name, default_version,installed_version\nFROM pg_available_extensions WHERE name LIKE 'postgis%' or name LIKE 'address%';\n```\n\n```sql\nCREATE EXTENSION postgis;\n```\n\n### Configuration\n\nTo be able to work, the application will need access to the database. `tifeatures` uses [starlette](https://www.starlette.io/config/)'s configuration pattern which make use of environment variable and/or `.env` file to pass variable to the application.\n\nExample of `.env` file can be found in [.env.example](https://github.com/developmentseed/tifeatures/blob/master/.env.example)\n\n```\n# you need define the DATABASE_URL directly\nDATABASE_URL=postgresql://username:password@0.0.0.0:5432/postgis\n```\n\n## Launch\n\n```bash\n$ pip install uvicorn\n\n# Set your postgis database instance URL in the environment\n$ export DATABASE_URL=postgresql://username:password@0.0.0.0:5432/postgis\n$ uvicorn tifeatures.main:app\n\n# or using Docker\n\n$ docker-compose up\n```\n\n<p align=\"center\">\n  <img src=\"https://user-images.githubusercontent.com/10407788/199774870-2e385617-bae8-4513-9349-d97e43670767.png\"/>\n</p>\n\n## Contribution & Development\n\nSee [CONTRIBUTING.md](https://github.com/developmentseed/tifeatures/blob/master/CONTRIBUTING.md)\n\n## License\n\nSee [LICENSE](https://github.com/developmentseed/tifeatures/blob/master/LICENSE)\n\n## Authors\n\nCreated by [Development Seed](<http://developmentseed.org>)\n\n## Changes\n\nSee [CHANGES.md](https://github.com/developmentseed/tifeatures/blob/master/CHANGES.md).\n\n",
    "bugtrack_url": null,
    "license": "MIT License\n        \n        Copyright (c) 2022 Development Seed\n        \n        Permission is hereby granted, free of charge, to any person obtaining a copy\n        of this software and associated documentation files (the \"Software\"), to deal\n        in the Software without restriction, including without limitation the rights\n        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n        copies of the Software, and to permit persons to whom the Software is\n        furnished to do so, subject to the following conditions:\n        \n        The above copyright notice and this permission notice shall be included in all\n        copies or substantial portions of the Software.\n        \n        THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n        SOFTWARE.",
    "summary": "Simple and Fast Geospatial Features API for PostGIS.",
    "version": "0.1.0a4",
    "split_keywords": [
        "fastapi",
        "ogc features",
        "postgis"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "84966e29215cc387c16d8769b570c6d71bc11d1df9eae4471a3ecc944f73fbb3",
                "md5": "2d8693576105515e6c6afc0bdec26906",
                "sha256": "af14ad4fda38ab939a14b9f60999e51265ae2b07db2385c51c0da477989696f3"
            },
            "downloads": -1,
            "filename": "tifeatures-0.1.0a4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2d8693576105515e6c6afc0bdec26906",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 43857,
            "upload_time": "2023-03-15T08:15:43",
            "upload_time_iso_8601": "2023-03-15T08:15:43.992532Z",
            "url": "https://files.pythonhosted.org/packages/84/96/6e29215cc387c16d8769b570c6d71bc11d1df9eae4471a3ecc944f73fbb3/tifeatures-0.1.0a4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "c5a705b5077a289c5c46c69780602734ef7fef0670019bdf86c623406540034c",
                "md5": "679127df1669423ffb68051bc3772629",
                "sha256": "b3c267f2b71626c01e6ffdcb45f055f7e3731da8e973253522f3c66b6ae83653"
            },
            "downloads": -1,
            "filename": "tifeatures-0.1.0a4.tar.gz",
            "has_sig": false,
            "md5_digest": "679127df1669423ffb68051bc3772629",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 35292,
            "upload_time": "2023-03-15T08:15:46",
            "upload_time_iso_8601": "2023-03-15T08:15:46.054523Z",
            "url": "https://files.pythonhosted.org/packages/c5/a7/05b5077a289c5c46c69780602734ef7fef0670019bdf86c623406540034c/tifeatures-0.1.0a4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-03-15 08:15:46",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "tifeatures"
}