@@ -4,42 +4,28 @@ Copyright (C) 2014-2015 Stichting Mapcode Foundation (http://www.mapcode.com)
44
55----
66
7- This Python project contains a module to encode latitude/longitude pairs to mapcodes
8- and to decode mapcodes back to latitude/longitude pairs.
7+ This Python project contains a module to encode latitude/longitude pairs
8+ to mapcodes and to decode mapcodes back to latitude/longitude pairs.
99
10- If you wish to use mapcodes in your own application landscape, consider using running an instance of the
11- Mapcode REST API, which can be found on: ** https://github.com/mapcode-foundation/mapcode-rest-service **
12-
13- # License
14-
15- Licensed under the Apache License, Version 2.0 (the "License");
16- you may not use this file except in compliance with the License.
17- You may obtain a copy of the License at
18-
19- http://www.apache.org/licenses/LICENSE-2.0
20-
21- Unless required by applicable law or agreed to in writing, software
22- distributed under the License is distributed on an "AS IS" BASIS,
23- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
24- See the License for the specific language governing permissions and
25- limitations under the License.
26-
27- Original C library created by Pieter Geelen. Work on Java version
28- of the mapcode library by Rijn Buve and Matthew Lowden. Python
29- interface by Erik Bos.
30-
31- # Status
32-
33- At the moment this module is still in development!
10+ If you wish to use mapcodes in your own application landscape, consider
11+ using running an instance of the Mapcode REST API, which can be found
12+ on: ** https://github.com/mapcode-foundation/mapcode-rest-service **
3413
3514# Bug Reports and New Feature Requests
3615
37- If you encounter any problems with this module, don't hesitate to use the ` Issues ` session to file your issues.
38- Normally, one of our developers should be able to comment on them and fix.
16+ If you encounter any problems with this module, don't hesitate to use the
17+ ` Issues ` session to file your issues. Normally, one of our developers
18+ should be able to comment on them and fix.
3919
4020# Installation
4121
42- Get the mapcode Python repository using:
22+ You install the mapcode module using pip:
23+
24+ ```
25+ pip install mapcode
26+ ```
27+
28+ or compile and install from source:
4329
4430```
4531git clone https://github.com/mapcode-foundation/mapcode-python
@@ -50,15 +36,6 @@ Compile the package in current directory: `python setup.py build_ext --inplace`
5036
5137Install in your Python environment using: ` python setup.py install `
5238
53- # Mapcode C library
54-
55- This Python module includes a copy of the Mapcode C library in the
56- directory mapcodelib. The latest version can be found on
57- https://github.com/mapcode-foundation/mapcode-cpp
58-
59- Updating it by replacing with the latest mapcode library should not
60- be an issue. Only the defined external functions are used.
61-
6239# Python methods
6340
6441The module exposes a number of methods:
@@ -108,7 +85,6 @@ print mapcode.isvalid('NLD 49.4V', 0)
10885False
10986```
11087
111-
11288# # Encoding
11389
11490Convert latitude/ longitude to one or more mapcodes. The response always
@@ -184,3 +160,30 @@ print mapcode.decode('IN VY.HV','USA')
184160print mapcode.decode(' IN VY.HV' ,' RUS' )
185161(43.193485 , 44.826592 )
186162```
163+
164+ # Mapcode C library
165+
166+ This Python module includes a copy of the Mapcode C library in the
167+ directory mapcodelib. The latest version can be found on
168+ https:// github.com/ mapcode- foundation/ mapcode- cpp
169+
170+ Updating it by replacing with the latest mapcode library should not
171+ be an issue. Only the defined external functions are used.
172+
173+ # License
174+
175+ Licensed under the Apache License, Version 2.0 (the " License" );
176+ you may not use this file except in compliance with the License.
177+ You may obtain a copy of the License at
178+
179+ http:// www.apache.org/ licenses/ LICENSE - 2.0
180+
181+ Unless required by applicable law or agreed to in writing, software
182+ distributed under the License is distributed on an " AS IS" BASIS ,
183+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND , either express or implied.
184+ See the License for the specific language governing permissions and
185+ limitations under the License.
186+
187+ Original C library created by Pieter Geelen. Work on Java version
188+ of the mapcode library by Rijn Buve and Matthew Lowden. Python
189+ interface by Erik Bos.
0 commit comments