Nickwasused/altv-python-masterlist

You can use this Package to interface with the alt:V master list API.

alt:V Masterlist for Python

---

This is a python3 package to interface with the alt:V Masterlist API.

📝 Table of Contents

• About
• Getting Started
• Deployment
• Usage
• Built Using
• Affiliation

🧐 About

This is a python3 package to interface with the alt:V Masterlist API.

🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them.

python3 is required. poetry is required

Installing

Install the required packages by running:

poetry install --all-extras

To run the tests:

poetry run pytest

To build the project:

poetry run build

🎈 Usage

See the docs: https://nickwasused.com/altv-python-masterlist/altvmasterlist.html

🚀 Deployment

None

Style

The code is formatted and checked with ruffs default settings.

⛏️ Built Using

• Poetry - Python packaging and dependency management
• Pytest - Code tests

Affiliation

I am not affiliated with the altMP team.