Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alphagov/mapit
GOV.UK fork of Mapit, a web service to map postcodes to administrative boundaries
https://github.com/alphagov/mapit
govuk govuk-pr-team
Last synced: about 1 month ago
JSON representation
GOV.UK fork of Mapit, a web service to map postcodes to administrative boundaries
- Host: GitHub
- URL: https://github.com/alphagov/mapit
- Owner: alphagov
- License: other
- Archived: true
- Fork: true (mysociety/mapit)
- Created: 2015-07-22T14:01:38.000Z (about 9 years ago)
- Default Branch: main
- Last Pushed: 2022-10-25T08:52:52.000Z (almost 2 years ago)
- Last Synced: 2024-04-27T22:34:47.561Z (5 months ago)
- Topics: govuk, govuk-pr-team
- Language: Python
- Homepage: https://docs.publishing.service.gov.uk/apps/mapit.html
- Size: 3.44 MB
- Stars: 12
- Watchers: 35
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.txt
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# MapIt
## As of October 2022, Mapit is no longer used for location services within GDS - You should now use [Locations API](https://github.com/alphagov/locations-api) and/or [Local Links Manager](https://github.com/alphagov/local-links-manager) to provide the functionality that Mapit once provided.
This is a fork of [the MapIt repo](https://github.com/mysociety/mapit). MapIt is a Python/Django application (backed by PostgreSQL), that provides RESTful API for looking up postcodes, council boundaries, etc.
**Avoid adding features, changing behaviours, or touching the code of MapIt itself**. The only [differences against the original repo](https://github.com/mysociety/mapit/compare/master...alphagov:main) should only be to help integrate it into the GOV.UK stack. So far this includes:
- [Pinning to specific versions of Python dependencies](https://github.com/alphagov/mapit/pull/1), for reliability
- [Adding a Procfile](https://github.com/alphagov/mapit/pull/2) and [unicornherder](https://github.com/alphagov/mapit/pull/12), to standardise deployment with other apps
- [A GOV.UK specific README](https://github.com/alphagov/mapit/pull/3), to provide context for GOV.UK developers
- [Importing a DB from S3](import-db-from-s3.sh), to simplify bringing new servers online with the same data
If we need to change the code itself, we should communicate with mysociety to try and push the work back upstream so everyone benefits.
## Nomenclature
- **Area**: a set of points that define an area that represents a geopolitical boundary of some sort. A country, a parliamentary constituency, a national park, a civil parish, etc.
- **Postcode**: an identifier for a small geographical area usually derived from postal data. Postcodes don't have boundaries, instead they have a lat/lng point which is the centroid of their area. The **Area**s for that **Postcode** are looked up by doing a geo search for those that contain the point.
- **Generation**: because areas change over time we add **Area**s to generations. If an area is in one generation but not another it is likely because legislation was enacted between those generations that meant it ceased to exist (often it is replaced by another similar but not exactly the same Area). Unless specified in the request mapit only searches in the current generation.
- **Type**: to identify what an area is it has a type. For example European parliamentary constituencies are type 'EUR' compared to Westminister parliamentary constituencies of type 'WMC'.
- **CodeType**: Areas have codes to allow them to be identified, issued by the ONS. Prior to 2011 these were SNAC codes (stored as type 'ons') (see: http://www.ons.gov.uk/ons/guide-method/geography/products/names--codes-and-look-ups/standard-names-and-codes/index.html), since 2011 these are GSS codes (stored as type 'gss') (see: http://neighbourhood.statistics.gov.uk/dissemination/Info.do?m=0&s=1460381709047&enc=1&page=nessgeography/new-geography-codes-and-naming-policy-from-1-january-2011.htm&nsjs=true&nsck=false&nssvg=false&nswid=1212)
- **ONSPD**: The Office for National Statistics Postcode Database - one of the open data sources we use to import data. We get UK postcodes from this.
- **Boundary Line**: The Ordnance Survey boundary line data - one of the open data sources we use to import data. We get GB Areas from this.
- **OSNI**: The Ordnance Survey of Northern Ireland - one of the providers of the open data sources we use to import data. We get NI Areas from them.
- **ONS**: Office for National Statistics
- **GSS**: Government Statistical Service, new ONS codes - GSS codes start with a letter, and are 9 characters long e.g. `S14000051`
- **SNAC**: old ONS codes - ONS codes consist of a number and/or character combination that could be
2, 4, 6, 8, or 10 characters long, and depending on the length, may only be numbers
- **SRID**: spatial reference identifier
## Technical documentation
You can use the [GOV.UK Docker environment](https://github.com/alphagov/govuk-docker) to run the application and its tests with all the necessary dependencies. Follow [the usage instructions](https://github.com/alphagov/govuk-docker#usage) to get started.
**Use GOV.UK Docker to run any commands that follow.**
### Running the application
To run management commands in other (non-development) environments, you'll need the `GOVUK_ENV` environment variable set.
### Running the test suite
```
./manage.py test mapit mapit_gb
```
### Further documentation
- [Original README](README.rst)
- [Importing data](docs/importing-data.md)
- [Testing a server with an updated Mapit database](docs/testing-server.md)
- [Example API output](docs/api.md)
## Licence
[GNU Affero GPL](LICENSE.txt)