-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
meta.yaml
404 lines (311 loc) · 19.3 KB
/
meta.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
{% set name = "lucit-licensing-python" %}
{% set version = "1.8.2" %}
package:
name: {{ name|lower }}
version: {{ version }}
source:
path: .
build:
script: {{ PYTHON }} -m pip install . -vv --no-deps --no-build-isolation
entry_points:
- lucitlicmgr=lucit_licensing_python.cli:main
number: 0
requirements:
build:
- {{ compiler('c') }}
host:
- python
- setuptools
- wheel
- cython
- pip
run:
- python
- cython
- requests
- simplejson
channels:
- lucit
- conda-forge
- default
dependencies:
- anaconda-client
- conda-build
test:
imports:
- lucit_licensing_python
commands:
- pip check
requires:
- pip
about:
summary: LUCIT Licensing Client Module
description: |
[](https://shop.lucit.services)
[](https://github.com/LUCIT-Systems-and-Development/lucit-licensing-python)
[](https://github.com/LUCIT-Systems-and-Development/lucit-licensing-python/releases)
[](https://github.com/LUCIT-Systems-and-Development/lucit-licensing-python/releases)
[](https://anaconda.org/lucit/lucit-licensing-python)
[](https://anaconda.org/lucit/lucit-licensing-python)
[](https://pypi.org/project/lucit-licensing-python/)
[](https://pepy.tech/project/lucit-licensing-python)
[](https://lucit-licensing-python.docs.lucit.tech/license.html)
[](https://www.python.org/downloads/)
[](https://github.com/LUCIT-Systems-and-Development/lucit-licensing-python/issues)
[](https://codecov.io/gh/LUCIT-Systems-and-Development/lucit-licensing-python)
[](https://github.com/LUCIT-Systems-and-Development/lucit-licensing-python/actions/workflows/unit-tests.yml)
[](https://github.com/LUCIT-Systems-and-Development/lucit-licensing-python/actions/workflows/codeql-analysis.yml)
[](https://github.com/LUCIT-Systems-and-Development/lucit-licensing-python/actions/workflows/build_wheels.yml)
[](https://github.com/LUCIT-Systems-and-Development/lucit-licensing-python/actions/workflows/build_conda.yml)
[](https://lucit-licensing-python.docs.lucit.tech)
[](https://t.me/unicorndevs)
[](https://app.gitter.im/#/room/#lucit-licensing-python:gitter.im)
# LUCIT Licensing Python (Module)
[Description](#description) | [Installation](#installation-and-upgrade) | [Change Log](#change-log) | [How To](#howto) |
[Wiki](#wiki) | [Social](#social) | [Notifications](#receive-notifications) |
[Bugs](#how-to-report-bugs-or-suggest-improvements) |
[Contributing](#contributing) | [Commercial Support](#commercial-support)
Python client module of the LUCIT Licensing Service.
## Description
This module is used to verify [LUCIT software licenses](https://shop.lucit.services/software) and also provides the
developer with a command line interface to interact with the LUCIT Licensing API.
If you have already installed modules of LUCIT like the
[UNICORN Binance Suite](https://www.lucit.tech/unicorn-binance-suite.html), which use the `lucit-licensing-python`
library, you have already installed the commandline tool `lucitlicmgr` automatically.
### Query contingents of your license
````
$ lucitlicmgr --quotas --apisecret bf7df011327d09b70fb0c6bfbc8661x33fdb0c58d42629c94ab35188d8d011ba --licensetoken 5e84cbd7-acfa-489f-a84d-z7d1b615af40d
````
Example output:
````
{'quotas': {'instances': {'available': 10, 'free': 10, 'used': 0},
'ips': {'available': 3, 'free': 2, 'used': 1},
'resets': {'available': 3, 'free': 3, 'used': 0}},
'signature': 'e762a949cb0987d6b6e11260a203752c1b2cbf1f8315f3eb6873100e528f8258',
'timestamp': '1697880811.9013143'}
````
The `apisecret` and the `licensetoken` parameter can also be loaded from an INI file. Simply create the file
[`lucit_license.ini`](https://raw.githubusercontent.com/LUCIT-Systems-and-Development/lucit-licensing-python/main/example_lucit_license.ini)
in the app root path or in your home directory in the folder `.lucit` e.g. `C:\Users\Name\.lucit` or
`/home/Name/.lucit`. with the following content:
````
[LUCIT]
api_secret = bf7df011327d09b70fb0c6bfbc8661x33fdb0c58d42629c94ab35188d8d011ba
license_token = 5e84cbd7-acfa-489f-a84d-z7d1b615af40d
````
Then just use:
````
$ lucitlicmgr --quotas
````
Example output:
````
{'quotas': {'instances': {'available': 10, 'free': 10, 'used': 0},
'ips': {'available': 3, 'free': 2, 'used': 1},
'resets': {'available': 3, 'free': 3, 'used': 0}},
'signature': 'e762a949cb0987d6b6e11260a203752c1b2cbf1f8315f3eb6873100e528f8258',
'timestamp': '1697880811.9013143'}
````
### Query information of your license
````
$ lucitlicmgr --info --apisecret bf7df011327d09b70fb0c6bfbc8661x33fdb0c58d42629c94ab35188d8d011ba --licensetoken 5e84cbd7-acfa-489f-a84d-z7d1b615af40d
````
Example output:
````
{'license': {'license_holder_email': 'johndoe82@gmail.com',
'license_holder_name': 'John Doe',
'licensed_product': 'UNICORN-BINANCE-SUITE',
'paid_till': '2023-10-24 18:39:03.681745+00:00'},
'signature': 'e0f7b631006c3480477f81e127729f2ee1489e2dd5dc0ffd7504fb590c4d515a',
'timestamp': '1697881034.4675057'}
````
The `apisecret` and the `licensetoken` parameter can also be loaded from an INI file. Simply create the file
[`lucit_license.ini`](https://raw.githubusercontent.com/LUCIT-Systems-and-Development/lucit-licensing-python/main/example_lucit_license.ini)
in the app root path or in your home directory in the folder `.lucit` e.g. `C:\Users\Name\.lucit` or
`/home/Name/.lucit`. with the following content:
````
[LUCIT]
api_secret = bf7df011327d09b70fb0c6bfbc8661x33fdb0c58d42629c94ab35188d8d011ba
license_token = 5e84cbd7-acfa-489f-a84d-z7d1b615af40d
````
Then just use:
````
$ lucitlicmgr --info
````
Example output:
````
{'license': {'license_holder_email': 'johndoe82@gmail.com',
'license_holder_name': 'John Doe',
'licensed_product': 'UNICORN-BINANCE-SUITE',
'paid_till': '2023-10-24 18:39:03.681745+00:00'},
'signature': 'e0f7b631006c3480477f81e127729f2ee1489e2dd5dc0ffd7504fb590c4d515a',
'timestamp': '1697881034.4675057'}
````
### Release the occupied slots of your quota.
**Please note:**
*This will stop ALL active instances. This command can be executed only 3 times every 24 hours.*
````
$ lucitlicmgr --reset --apisecret bf7df011327d09b70fb0c6bfbc8661x33fdb0c58d42629c94ab35188d8d011ba --licensetoken 5e84cbd7-acfa-489f-a84d-z7d1b615af40d
````
Example output:
````
{'reset': {'status': 'SUCCESSFUL'},
'signature': '25e8868f963f583f451c0ce1d7bf8daeaaeae4a17db0265adace034232e6f925',
'timestamp': '1697881249.771824'}
````
The `apisecret` and the `licensetoken` parameter can also be loaded from an INI file. Simply create the file
[`lucit_license.ini`](https://raw.githubusercontent.com/LUCIT-Systems-and-Development/lucit-licensing-python/main/example_lucit_license.ini)
in the app root path or in your home directory in the folder `.lucit` e.g. `C:\Users\Name\.lucit` or
`/home/Name/.lucit`. with the following content:
````
[LUCIT]
api_secret = bf7df011327d09b70fb0c6bfbc8661x33fdb0c58d42629c94ab35188d8d011ba
license_token = 5e84cbd7-acfa-489f-a84d-z7d1b615af40d
````
Then just use:
````
$ lucitlicmgr --reset
````
Example output:
````
{'reset': {'status': 'SUCCESSFUL'},
'signature': '25e8868f963f583f451c0ce1d7bf8daeaaeae4a17db0265adace034232e6f925',
'timestamp': '1697881249.771824'}
````
### Test the availability of the Licensing API
````
$ lucitlicmgr --test
````
Example output:
````
{'message': 'Hello World!'}
````
### Use multiple licenses (multi tenant) with profiles
Simply create the file
[`lucit_license.ini`](https://raw.githubusercontent.com/LUCIT-Systems-and-Development/lucit-licensing-python/main/example_lucit_license.ini)
in the app root path or in your home directory in the folder `.lucit` e.g. `C:\Users\Name\.lucit` or
`/home/Name/.lucit`. with the following content:
````
[LUCIT]
api_secret = bf7df011327d09b70fb0c6bfbc8661x33fdb0c58d42629c94ab35188d8d011ba
license_token = 5e84cbd7-acfa-489f-a84d-z7d1b615af40d
[TENANT_A]
api_secret = 62a9efe20be3d038d3be15ea339495629c096ad22762fa7b72ee2df607f194d3
license_token = f829d452-651b-4c6a-89a0-t742a16d0010e
````
Then just use:
````
$ lucitlicmgr --info --licenseprofile TENANT_A
````
Example output:
````
{'license': {'license_holder_email': 'tenant_a@gmail.com',
'license_holder_name': 'Tenant A',
'licensed_product': 'UNICORN-BINANCE-SUITE',
'paid_till': '2023-11-02 13:43:22.723258+00:00'},
'signature': 'e0f7b631006c3480477f81e127729f2ee1489e2dd5dc0ffd7504fb590c4d515a',
'timestamp': '1697881034.4675057'}
````
***Note:***
All UNICORN Binance Suite modules also support the use of profiles. Please read the documentation of the respective
module regarding the parameter `license_profile`.
### Discover more options
````
$ lucitlicmgr --help
````
## Installation and Upgrade
The module requires Python 3.7 or above.
The current dependencies are listed
[here](https://github.com/LUCIT-Systems-and-Development/lucit-licensing-python/blob/master/requirements.txt).
If you run into errors during the installation take a look [here](https://github.com/LUCIT-Systems-and-Development/lucit-licensing-python/wiki/Installation).
### A Cython binary, PyPy or source code based CPython wheel of the latest version with `pip` from [PyPI](https://pypi.org/project/lucit-licensing-python/)
Our [Cython](https://cython.org/) and [PyPy](https://www.pypy.org/) Wheels are available on [PyPI](https://pypi.org/),
these wheels offer significant advantages for Python developers:
- ***Performance Boost with Cython Wheels:***
Cython is a programming language that supplements Python with static typing and C-level performance. By compiling
Python code into C, Cython Wheels can significantly enhance the execution speed of Python code, especially in
computationally intensive tasks. This means faster runtimes and more efficient processing for users of our package.
- ***PyPy Wheels for Enhanced Efficiency:***
PyPy is an alternative Python interpreter known for its speed and efficiency. It uses Just-In-Time (JIT) compilation,
which can dramatically improve the performance of Python code. Our PyPy Wheels are tailored for compatibility with
PyPy, allowing users to leverage this speed advantage seamlessly.
Both Cython and PyPy Wheels on PyPI make the installation process simpler and more straightforward. They ensure that
you get the optimized version of our package with minimal setup, allowing you to focus on development rather than
configuration.
#### Installation
`pip install lucit-licensing-python`
#### Update
`pip install lucit-licensing-python --upgrade`
### A Conda Package of the latest version with `conda` from [Anaconda](https://anaconda.org/lucit)
The `lucit-licensing-python` package is available with [Conda](https://docs.conda.io/en/latest/) through the
[`lucit` channel](https://anaconda.org/lucit).
For optimal compatibility and performance, it is recommended to source the necessary dependencies from the
[`conda-forge` channel](https://anaconda.org/conda-forge).
#### Installation
```
conda config --add channels conda-forge
conda config --add channels lucit
conda install -c lucit lucit-licensing-python
```
#### Update
`conda update -c lucit lucit-licensing-python`
### From source of the latest release with PIP from [GitHub](https://github.com/LUCIT-Systems-and-Development/lucit-licensing-python)
#### Linux, macOS, ...
Run in bash:
`pip install https://github.com/LUCIT-Systems-and-Development/lucit-licensing-python/archive/$(curl -s https://api.github.com/repos/LUCIT-Systems-and-Development/lucit-licensing-python/releases/latest | grep -oP '"tag_name": "\K(.*)(?=")').tar.gz --upgrade`
#### Windows
Use the below command with the version (such as 1.8.2) you determined
[here](https://github.com/LUCIT-Systems-and-Development/lucit-licensing-python/releases/latest):
`pip install https://github.com/LUCIT-Systems-and-Development/lucit-licensing-python/archive/1.8.2.tar.gz --upgrade`
### From the latest source (dev-stage) with PIP from [GitHub](https://github.com/LUCIT-Systems-and-Development/lucit-licensing-python)
This is not a release version and can not be considered to be stable!
`pip install https://github.com/LUCIT-Systems-and-Development/lucit-licensing-python/tarball/master --upgrade`
### [Conda environment](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html), [Virtualenv](https://virtualenv.pypa.io/en/latest/) or plain [Python](https://www.python.org)
Download the [latest release](https://github.com/LUCIT-Systems-and-Development/lucit-licensing-python/releases/latest)
or the [current master branch](https://github.com/LUCIT-Systems-and-Development/lucit-licensing-python/archive/master.zip)
and use:
- ./environment.yml
- ./meta.yaml
- ./pyproject.toml
- ./requirements.txt
- ./setup.py
## Change Log
[https://lucit-licensing-python.docs.lucit.tech/changelog.html](https://lucit-licensing-python.docs.lucit.tech/changelog.html)
## Howto
- [How to Obtain and Use a Unicorn Binance Suite License Key and Run the UBS Module According to Best Practice](https://medium.lucit.tech/how-to-obtain-and-use-a-unicorn-binance-suite-license-key-and-run-the-ubs-module-according-to-best-87b0088124a8)
## Project Homepage
[https://www.lucit.tech/lucit-licensing-python.html](https://www.lucit.tech/lucit-licensing-python.html)
## Wiki
[https://github.com/LUCIT-Systems-and-Development/lucit-licensing-python/wiki](https://github.com/LUCIT-Systems-and-Development/lucit-licensing-python/wiki)
## Social
- [Discussions](https://github.com/LUCIT-Systems-and-Development/lucit-licensing/discussions)
- [Gitter](https://app.gitter.im/#/room/#lucit-licensing-python:gitter.im)
- [https://t.me/unicorndevs](https://t.me/unicorndevs)
## Receive Notifications
Follow us on [LinkedIn](https://www.linkedin.com/company/lucit-systems-and-development),
[X](https://twitter.com/LUCIT_SysDev) or [Facebook](https://www.facebook.com/lucit.systems.and.development)!
## How to report Bugs or suggest Improvements?
[List of planned features](https://github.com/LUCIT-Systems-and-Development/lucit-licensing-python/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement) -
click  if you need one of them or suggest a new feature!
Before you report a bug, [try the latest release](https://github.com/LUCIT-Systems-and-Development/lucit-licensing-python#installation-and-upgrade). If the issue still exists, provide the error trace, OS
and Python version and explain how to reproduce the error. A demo script is appreciated.
If you don't find an issue related to your topic, please open a new [issue](https://github.com/LUCIT-Systems-and-Development/lucit-licensing-python/issues)!
[Report a security bug!](https://github.com/LUCIT-Systems-and-Development/lucit-licensing-python/security/policy)
## Contributing
[LUCIT Licensing Python](https://www.lucit.tech/lucit-licensing-python.html) is an open
source project which welcomes contributions which can be anything from simple documentation fixes and reporting dead links to new features. To
contribute follow
[this guide](https://github.com/LUCIT-Systems-and-Development/lucit-licensing-python/blob/master/CONTRIBUTING.md).
### Contributors
[](https://github.com/LUCIT-Systems-and-Development/lucit-licensing-python/graphs/contributors)
We  open source!
## Commercial Support
[](https://www.lucit.tech/get-support.html)
***Do you need a developer, operator or consultant?*** [Contact us](https://www.lucit.tech/contact.html) for a non-binding initial consultation!
dev_url: https://github.com/LUCIT-Systems-and-Development/lucit-licensing-python
doc_url: https://lucit-licensing-python.docs.lucit.tech
home: https://www.lucit.tech/lucit-licensing-python.html
license: LSOSL
license_file: LICENSE
extra:
recipe-maintainers:
- oliver-zehentleitner