Skip to main content

Python toolkit for Urban Data processing

Project description

Metacity

Build Status Coverage Status Pypi version

Toolkit for Urban Data Preprocessing

Installation

Generally, if you have GDAL and CMake installed on your system, all you need to do is:

pip install metacity

Dependencies

This repository relies on system packages GDAL and CMake, please make sure they are installed before trying to install this package.

  1. Install GDAL
sudo add-apt-repository ppa:ubuntugis/ppa
sudo apt-get update
sudo apt-get install gdal-bin
  1. Install CMake
sudo apt-get install cmake

For Contributors

If you wish to contribute, please follow these 2 steps:

  1. Push your code into your own separate branch
  2. Once you are satisfied with the changes, create a pull request

Please, make sure to:

  • never push code into main or dev branches
  • check if you haven't accidentally pushed any files that should be in .gitignore

Development

  1. Clone this repository:
git clone git@github.com:MetacitySuite/Metacity.git
  1. Initialize submodules:
git submodule update --init --recursive
  1. Install requirements:
pip install -r requirements.txt
  1. Build C++ with:
python setup.py build_ext --inplace

Debugging

If you encounter any problems, make sure you installed dependencies listed above, generally:

  • have GDAL and CMake installed
  • install packages based on requirements.txt
  • make sure you have c++ compiler supporting c++14 installed

For Maintainers

Branches

Branch Status Description
main Build Status protected, merged PRs auto tested and deployed to PyPI
dev Build Status merged PRs auto tested and version bumped if tag present

PR Merge Commit message conventions

Use any of the following tags in the merge commit message title to indicate the type of PR:

In commit message Descrition Branches
action::bump flag to run bump package version dev
action::package flag to run deploy to PyPI main

Dev branch actions (together with action::bump):

In commit message Descrition Branches
version::patch bump version after patch/bug fix/minor change dev
version::minor bump version after new feature/minor change dev
version::major bump version after major change/breaking change dev

If no tag is used, no action runs after the PR is merged. If no version tag is used, the version is bumped as patch.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

metacity-0.4.0.tar.gz (709.5 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page