Skip to main content

Python API and CLI for managing Proximatic configuration.

Project description


Python API for managing Proximatic configuration files.

When installed, the proximatic command provides a CLI for managing Proximatic configuration.

This Python package provides the core for the Proximatic system.

If you are looking for the turn-key production deployment of Proximatic, see


pip install proximatic


Command Line Interface (CLI)

Open a Terminal and type:


Use proximatic --help for available commands and options.

Python API programmatic interface

from proximatic import Proximatic
proximatic = Proximatic(yml_dir='/path/to/your/proximatic/data', fqdn='')

JSON REST API interface

You can run the (experimental) REST API on your localhost by typing the command:


It will try to open your browser to http://localhost:8000


The MIT License (MIT)


Link Swanson (LunkRat)

Project details

Download files

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

Source Distribution

proximatic-0.1.7.tar.gz (8.0 kB view hashes)

Uploaded source

Built Distribution

proximatic-0.1.7-py3-none-any.whl (9.3 kB view hashes)

Uploaded py3

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