keops-vt


Namekeops-vt JSON
Version 1.0.0 PyPI version JSON
download
home_page
SummaryCLI tool for custom edition and management of Mapbox Vector Tiles in MBTiles format
upload_time2023-04-13 18:41:29
maintainer
docs_urlNone
author
requires_python>=3.7
licenseMIT
keywords mbtiles python vector-tiles
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Keops
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#wip)
![CI](https://github.com/fmariv/keops-vt/actions/workflows/test_lint.yaml/badge.svg)

<p align="center">
    <img src="favicon.png" alt="Keops logo">
</p>

Keops is a CLI tool that allows you to apply some logic to vector tiles in a MBTiles file, such as removing or getting the size of a given tile, obtaining the vector layers that conform the MBTiles or shrinking the vector data, in order to reduce the data size.

Read the full documentation for more details: [keops.franmartin.es](https://keops.franmartin.es/).

## Installation

Keops needs Python 3.7 or higher. The recommended way to install it is via [pip](https://pypi.org/project/keops-tiles/).

``` 
pip install keops-vt
```

If you want to run the ```shrink``` command you also need [Docker](https://www.docker.com/).

## CLI Usage

The usage is pretty simple and straigthforward. For instance, if you want to drop a given tile in a MBTiles:

```bash
keops erase input.mbtiles 6/10/23
```

Keops have some more functionalities. To check them, simply execute ```keops``` or ```keops --help``` in your bash.

```bash
Usage: keops [OPTIONS] COMMAND [ARGS]...

  Keops command line interface

Options:
  --help  Show this message and exit.
 
Commands:
  debug   Debug a MBTiles file: get info related with layers and their
          features in a given MBTiles
  erase   Erase a tile in a MBTiles file
  info    Extract and print the metadata info from a MBTiles file
  shrink  Reduce and simplify all features of all or any vector tiles in a
          MBTiles container. Docker required.
  size    Get the size of a given tile or zoom level in a MBTiles file


```

## Roadmap

If you are interested on the roadmap of the project, check the [ROADMAP](ROADMAP.md) file.

## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE.md) file for details.

## Credits

The merit of the shrink module belongs entirely to [rastapasta](https://github.com/rastapasta/tileshrink), as the unique developer of tileshrink,
and [ooZberg](https://github.com/ooZberg), as the person who wrapped it in a Docker image in order to use it without worrying
about the Node.js version. What I have done is creating a backup of the Docker image and 
wrapping it again in this package, so it can be used in a focused environment.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "keops-vt",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "mbtiles,python,vector-tiles",
    "author": "",
    "author_email": "Fran Mart\u00edn <fmartinrivas2@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/57/45/c82bda2d4d632a2c31573207a96abcbfa73e98b5046e3f95762d00e7634c/keops-vt-1.0.0.tar.gz",
    "platform": null,
    "description": "# Keops\n[![Project Status: Active \u2013 The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#wip)\n![CI](https://github.com/fmariv/keops-vt/actions/workflows/test_lint.yaml/badge.svg)\n\n<p align=\"center\">\n    <img src=\"favicon.png\" alt=\"Keops logo\">\n</p>\n\nKeops is a CLI tool that allows you to apply some logic to vector tiles in a MBTiles file, such as removing or getting the size of a given tile, obtaining the vector layers that conform the MBTiles or shrinking the vector data, in order to reduce the data size.\n\nRead the full documentation for more details: [keops.franmartin.es](https://keops.franmartin.es/).\n\n## Installation\n\nKeops needs Python 3.7 or higher. The recommended way to install it is via [pip](https://pypi.org/project/keops-tiles/).\n\n``` \npip install keops-vt\n```\n\nIf you want to run the ```shrink``` command you also need [Docker](https://www.docker.com/).\n\n## CLI Usage\n\nThe usage is pretty simple and straigthforward. For instance, if you want to drop a given tile in a MBTiles:\n\n```bash\nkeops erase input.mbtiles 6/10/23\n```\n\nKeops have some more functionalities. To check them, simply execute ```keops``` or ```keops --help``` in your bash.\n\n```bash\nUsage: keops [OPTIONS] COMMAND [ARGS]...\n\n  Keops command line interface\n\nOptions:\n  --help  Show this message and exit.\n \nCommands:\n  debug   Debug a MBTiles file: get info related with layers and their\n          features in a given MBTiles\n  erase   Erase a tile in a MBTiles file\n  info    Extract and print the metadata info from a MBTiles file\n  shrink  Reduce and simplify all features of all or any vector tiles in a\n          MBTiles container. Docker required.\n  size    Get the size of a given tile or zoom level in a MBTiles file\n\n\n```\n\n## Roadmap\n\nIf you are interested on the roadmap of the project, check the [ROADMAP](ROADMAP.md) file.\n\n## License\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE.md) file for details.\n\n## Credits\n\nThe merit of the shrink module belongs entirely to [rastapasta](https://github.com/rastapasta/tileshrink), as the unique developer of tileshrink,\nand [ooZberg](https://github.com/ooZberg), as the person who wrapped it in a Docker image in order to use it without worrying\nabout the Node.js version. What I have done is creating a backup of the Docker image and \nwrapping it again in this package, so it can be used in a focused environment.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "CLI tool for custom edition and management of Mapbox Vector Tiles in MBTiles format",
    "version": "1.0.0",
    "split_keywords": [
        "mbtiles",
        "python",
        "vector-tiles"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b269415417705ffc12f2230639659ba5fbd09403bcba46d0dae3c1b93fe92989",
                "md5": "1a32b9d1d38aa8434e8ad2cf7c5d2591",
                "sha256": "c4ebf64fa9756d1c5df115ddbdf1e51f4d3baa28ee325fd434a78d4db9e9deb3"
            },
            "downloads": -1,
            "filename": "keops_vt-1.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1a32b9d1d38aa8434e8ad2cf7c5d2591",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 14914,
            "upload_time": "2023-04-13T18:41:28",
            "upload_time_iso_8601": "2023-04-13T18:41:28.251013Z",
            "url": "https://files.pythonhosted.org/packages/b2/69/415417705ffc12f2230639659ba5fbd09403bcba46d0dae3c1b93fe92989/keops_vt-1.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5745c82bda2d4d632a2c31573207a96abcbfa73e98b5046e3f95762d00e7634c",
                "md5": "3e9d9ee454f560b308c2e978f2b8eb6f",
                "sha256": "733449206d1ed3990bc0366c81d3062e86633044655479bce8e2a85252427f7c"
            },
            "downloads": -1,
            "filename": "keops-vt-1.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "3e9d9ee454f560b308c2e978f2b8eb6f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 13301,
            "upload_time": "2023-04-13T18:41:29",
            "upload_time_iso_8601": "2023-04-13T18:41:29.775303Z",
            "url": "https://files.pythonhosted.org/packages/57/45/c82bda2d4d632a2c31573207a96abcbfa73e98b5046e3f95762d00e7634c/keops-vt-1.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-04-13 18:41:29",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "keops-vt"
}
        
Elapsed time: 0.07038s