augmented 🧚
augmented is a cross platform module used to do augmented reality using python
Requirements 🟥
- opencv-contrib-python
- Numpy
- requirements may vary on diffrent operating systems
instalation ⬇️
pip install augmented
Thats it 🌟
How to use ❓
Overlaying images 🖼️
initializing 🏁
import augmented
ar = augmented.ar_overlay(capture:int)#capture = camera number
ar.setup(targetImage: str, overlayImage: str, nfeatures: int, debug: bool=True, confidence: int=25, displayName: str="Augmented by sarang")
-
targetImage = Image to overlay on top of
-
overlayImage =Image to overlay
-
nfeatures = Features to detect on target image the bigger the more accurate and the more resource intensive 1000 recomended
Not required but can tweak the ones below 💻
-
debug = debug mode
-
confidence = How many feature matches to confirm
-
displayname = title name```
Overlaying
ar.start(display=bool)
- display = Enabling display output
Aruco scanning 📱
setup 🖱️
import augmented
arucoar = augmented.arucoar(cap:int=0)
imgAug = {0: 'assets/unnamed.jpg'}
arucoar.setup(imgAug: dict, markerSize: int = 6, totalMarkers: int = 250, debug: bool = True, cam: int = 0, displayName: str = 'Augmented by Sarang')
- imgAug = a dict containing the aruco id as value and the image(location) to display when the value is True
not neccessry but still can tweak 💻
-
Markersize, totalMarkers = aruco code properties
-
debug = to use debug mode
-
cam = camera number
-
displayName = tite of the display window
Scanning and overlaying 🖼️
arucoar.start(display=bool)
- display = wheather to display the output or not
recomended way of using is to put the code inside a loop 🌠
version - 2.1.0Stable
contributions are appreciated and will be credited in the package
Thank you
Happy augmenting
Updated setup.py for modern python versions
Metadata
Release files for augmented 2.4.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| augmented-2.4.2.tar.gz | 5.6 MB | Without provenance | Details for augmented-2.4.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| augmented-2.4.2-py3-none-any.whl | Python 3 | none | any | Details for augmented-2.4.2-py3-none-any.whl |
Total release size: 5.6 MB
Release files / augmented-2.4.2.tar.gz
| Download URL | augmented-2.4.2.tar.gz |
|---|---|
| Size | 5.6 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e85d9a360edfbbb4bcc96960bf47c58b84e483bb0282a74f2dbd32e682cd3416
|
|
BLAKE2b-256 checksum How to use checksums |
ff84808d08403856aacf9604e1560921bfc6031865e6f0685fdc37104deccb85
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.5
|
Release files / augmented-2.4.2-py3-none-any.whl
| Download URL | augmented-2.4.2-py3-none-any.whl |
|---|---|
| Size | 5.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
25afd961550f88d2afd0b61bb7a1b3ceab1d8a7afb26fb25dd2b3920c330a4a1
|
|
BLAKE2b-256 checksum How to use checksums |
6924e54b19f233cc4831dd3140d0e4d81e00b78dcf8e7e73f84caaeadf1b7374
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.5
|
Security for augmented 2.4.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.