Metadata-Version: 2.1
Name: rustmaps.py
Version: 0.2.0
Summary: Wrapper for the rustmaps.com REST API
Home-page: https://github.com/RalphORama/rustmaps.py/
License: AGPL-3.0-or-later
Keywords: requests,api,development
Author: Ralph Drake
Author-email: pypi@ralphdrake.com
Requires-Python: >=3.8,<4.0
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Internet :: WWW/HTTP
Requires-Dist: requests (>=2.28.1,<3.0.0)
Project-URL: Repository, https://github.com/RalphORama/rustmaps.py/
Description-Content-Type: text/markdown

# rustmaps.py

[![PyPI version](https://badge.fury.io/py/rustmaps.py.svg)](https://badge.fury.io/py/rustmaps.py)
[![CI status](https://github.com/RalphORama/rustmaps.py/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/RalphORama/rustmaps.py/actions/workflows/ci.yml)

This package provides a Python interface for [rustmaps.com's HTTP REST API][1].

**NB:** This is my first API wrapper package so it may have some issues. If you
find any I would greatly appreciate it if you opened an issue or pull request!


## Roadmap to 1.0.0

The current features are not implemented:

- [ ] `maps/filter/{filterId}` endpoint (paginated map searching)
- [ ] v2Beta endpoints (`beta/outposts` and `beta/map/custom`)


## Contributing

This project uses flake8 with default settings. Please make sure your code
passes `poetry run flake8` and `poetry run pytest` before opening a pull
request.

This project is designed to work with Python 3.8.0+. Please do not open pull
requests with features that break this compatibility.


[1]: https://rustmaps.com/docs/index.html

