Skip to main content

Simple licensing helper using mongodb

Project description

pylicensing

Pylicensing is a leightweight tool designed to make key authentication and creation on your distributed python programs easier. It connects to a mongodb database. Click this link to learn more about mongodb, a nosql easy-to-use database with a free tier.

How to install

Pylicensing can be installed via pypi

pip install pylicensing

Warning

I do not recommend to connect to the database on the client directly. If your program was to be cracked, you would expose a database connection string to a possibly malicious person. Be precautious and introduce an API between your client and the database. Pylicensing provides the methods your API client needs.

You can still use pylicensing on your user client, as you could for example check that the Key your user entered conforms the KeyFormat you used for your application, this would prevent people from spamming meaningless keys.

Features

  • Customize the Format of a Key, i.e allow sets of characters, customize amount of sections...
  • Key metadata (creation date, expiration date, owner, hwids..)
  • HWID limitations and registrations (max hwids, registered hwids...)
  • Key format validations, to avoid requesting a database query.
  • Easy database management and queries

Example

You can also check the examples folder in the repository for more detailed examples.

Creating a Key object

my_key_format = KeyFormat(
    sections=5, chars_per_section=5, seperator="-", numeric_characters=True
)
new_user_key = Key.create(
    my_key_format, user="Freddie Faulig", hwid_limit=1, valid_for=timedelta(days=30)
)

Establishing your database connection

client: MongoClient = MongoClient(os.environ.get("DATABASE_CONNECTION"))
key_manager = KeyManager(client.test.example)

Adding a key to the database

new_user_key = Key.create(
    my_key_format, user="Freddie Faulig", hwid_limit=1, valid_for=timedelta(days=30)
)
key_manager = KeyManager(client.test.example)

key_manager.add_to_collection(new_user_key)

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

pylicensing-0.0.3.tar.gz (11.5 kB view hashes)

Uploaded Source

Built Distribution

pylicensing-0.0.3-py3-none-any.whl (10.9 kB view hashes)

Uploaded Python 3

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