rayid 1.1.0__py3-none-any.whl

rayid/__init__.py

@@ -0,0 +1,3 @@
+from rayid.rayid import RayID
+
+__all__ = ["RayID"]

rayid/rayid.py

@@ -0,0 +1,51 @@
+import secrets
+from typing import Literal
+
+IDType = Literal["digit", "lower", "upper", "all"]
+
+VALUES: dict[str, str] = {
+    "digit": "0123456789",
+    "lower": "abcdefghijklmnopqrstuvwxyz",
+    "upper": "ABCDEFGHIJKLMNOPQRSTUVWXYZ",
+}
+
+VALUES["all"] = "".join(VALUES.values())
+
+
+class RayID:
+    def __init__(self, type: IDType) -> None:
+        if type not in VALUES:
+            raise ValueError(
+                f"Invalid ID type: {type!r}. " f"Expected one of: {', '.join(VALUES)}"
+            )
+
+        self.type: IDType = type
+
+    def characters(self) -> str:
+        return VALUES[self.type]
+
+    def engine(self, length: int) -> str:
+        if not isinstance(length, int) or isinstance(length, bool):
+            raise TypeError("Length must be an integer.")
+
+        if length <= 0:
+            raise ValueError("Length must be greater than zero.")
+
+        characters = self.characters()
+
+        return "".join(secrets.choice(characters) for _ in range(length))
+
+    def gen(self, length: int) -> str:
+        if not isinstance(length, int) or isinstance(length, bool):
+            raise TypeError("Length must be an integer.")
+
+        if length <= 0:
+            raise ValueError("Length must be greater than zero.")
+
+        characters = self.characters()
+        first_characters = characters.replace("0", "")
+
+        first = secrets.choice(first_characters)
+        remaining = "".join(secrets.choice(characters) for _ in range(length - 1))
+
+        return first + remaining

rayid-1.1.0.dist-info/METADATA

@@ -0,0 +1,160 @@
+Metadata-Version: 2.4
+Name: rayid
+Version: 1.1.0
+Summary: RayID is a generated code that we use to track logs, posts or events.
+Home-page: https://gitlab.com/blackiq-packages/pypi/rayid
+Author: Amirhossein Mohammadi
+Author-email: Amirhossein Mohammadi <amirhosseinmohammadi1380@yahoo.com>
+License: MIT License
+        
+        Copyright (c) 2023 RayID
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://gitlab.com/blackiq-packages/pypi/rayid
+Project-URL: Repository, https://gitlab.com/blackiq-packages/pypi/rayid
+Project-URL: Issues, https://gitlab.com/blackiq-packages/pypi/rayid/-/issues
+Keywords: rayid,id,generator,random,tracking
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: author
+Dynamic: home-page
+Dynamic: license-file
+
+# RayID
+
+**RayID** is a generated code that we use to track logs, posts or events. You can generate your own rayid, but we made your job easier!
+
+In this instructure you will learn about how to use this package in your apps.
+
+## Table of content
+
+- [Languages](#languages)
+- [Installation](#installation)
+- [methods](#methods)
+- [Development](#development)
+
+## Languages
+
+I created rayid for **JavaScript** too.
+
+- [GitLab](https://gitlab.com/BlackIQ/rayid)
+- [Npm](https://www.npmjs.com/package/rayid)
+
+## Installation
+
+How to install **RayID**? To install this package, use **pip** or **pipenv**.
+
+```shell
+$ pip3 install rayid
+# Or
+$ pipenv install rayid
+```
+
+## Config
+
+So, import the package.
+
+```python
+from rayid import RayID
+
+rayid = RayID("digit")
+```
+
+Now create your instance with what kind of rayid you want.
+
+- digit: Numbers
+- lower: Alphabet in lower case.
+- upper: Alphabet in upper case.
+- all: Combine of all types.
+
+> No type means all combined togather.
+
+```python
+rayid = RayID("digit")
+```
+
+## Methods
+
+Only one method! `gen(len)`.
+
+### `gen(len)`
+
+in **gen(len)** just say the length.
+
+> There is no limit :)
+
+```python
+id = rayid.gen(25);
+print(id); # 9514992619709220193874433
+```
+
+## Examples
+
+Create common instances.
+
+```python
+all = RayID("all"); # All values
+str = RayID("lower"); # Loercase generator
+int = RayID("digit"); # Only int generator
+```
+
+Now use them:
+
+```python
+print(all.gen(10)); # Z*jVQ3c:+H
+print(str.gen(10)); # ksixvpqohi
+print(int.gen(10)); # 4748182066
+```
+
+All done!
+
+---
+
+## Development
+
+If you want to develop the package, it is so simple. just follow steps below.
+
+- Clone the project
+- Start changing!
+
+> Before you start: **Remember the base or code are stored in `rayid/rayid.py`**. You need to edit there.
+
+### Cloning the project
+
+To clone the project, you need to have git installed. Ok, now clone it same as command below.
+
+```shell
+$ git clone https:#github.com/BlackIQ/rayid
+```
+
+### Changing
+
+To change package or anything, your need a testing environment to use linked package. Just change `rayid/rayid.py`.
+
+#### Test
+
+Your test app is linked. Change anything in package and test it in `test.py` file.

rayid-1.1.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+rayid/__init__.py,sha256=Ve_caw0pvZVLOVFbw8oOQdWUbJaYY6Lh9qb72mvVby4,51
+rayid/rayid.py,sha256=EGmGq-ap86RQRI_bprXkzg-KKpFlKVockwfhxQ9L9Mk,1497
+rayid-1.1.0.dist-info/licenses/LICENSE,sha256=3d0_ccpx_bKFz0ECGZZfVGZ2Tqf7-UG6Wj--9KQluDM,1062
+rayid-1.1.0.dist-info/METADATA,sha256=PmgJUHTjTvo03kz0UqUJqRjar3d0cCBbx7GpE6mEhVw,4420
+rayid-1.1.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+rayid-1.1.0.dist-info/top_level.txt,sha256=3R7ai9mCikxcxmR_VjLDHprN6npUOUMf0fer8w573ww,6
+rayid-1.1.0.dist-info/RECORD,,

rayid-1.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.2.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

rayid-1.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 RayID
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

rayid-1.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+rayid