🧱 Project Description¶
📝 Name¶
logyca-azure-storage-blob
📝 Environment variables¶
Copy from .env.sample to .env to create environment variables for the developer on the local machine.
🧰 Examples of SDK calls to interact with the Azure Storage blob container service using Python
In this examples folder, you'll find console scripts for tasks such as uploading, downloading, modifying properties, deleting, and searching for files by modification date.
pip install -r .\requirements.tx
🗂️ Name prefix for folder naming in services or other¶
🐍 Based on https://fastapi.tiangolo.com/tutorial/bigger-applications/
| Prefix | Service Type | Example Folder | Description |
|---|---|---|---|
| 🌐 Api | Web API | ApiOrderManagement |
RESTful backend for general use. |
| 💻 App | Web App | AppFrontendPortal |
Frontend or user-facing web app. |
| 🟦 Azf | Azure Function | AzfDataProcessor |
Cloud functions for event-driven tasks. |
| 🟦 Doc | Documentacion | Docs |
Project/Functional documentation |
| 🧩 Mcs | Microservice | McsUserProfile |
Independent service with isolated logic. |
| 🧰 Ops | Infrastructure and Operations | Ops + Subfolders |
Docker compose, CI/CD, backups, scripts or command-line tools, configs. |
| 🖥️ Dat | Storage / Databases | Database / DataEngineer + Subfolders |
Databases. |
| 🛢️ Sup | Support / Infra | SupStorageTools |
Cache admin or infra tools. |
| 🧭 Wrk | Worker | WrkEmailDispatcher |
Background or async job processor. |
☁️🛢️ Azure Storage account | 🛡️ 🔐 access keys¶
- Copy the environment variable template located in the root of the
.env.sampledirectory to a file named.envin the same directory. - 🗝️ Obtain the access keys and write them to
.env
🧠 Examples of SDK calls to interact with the Azure Storage Account Blob Container Service using Python¶
The sample scripts are designed to run sequentially.
Therefore, the credentials in the .env environment variable file are tested initially, followed by the creation of test containers.
Then, the scripts perform actions such as loading, unloading, modifying properties, deleting, and searching for files by modification date.
The sequence is: sample_01..sample_99
📚 Documentation Contents¶
| Description | Location / Link |
|---|---|
| Main documentation file. Provides general overview, installation and usage instructions. | README.md |
| Recommended directory structure. | Directory structure |
| Development setup using Visual Studio Code. | Developed using Microsoft Visual Studio Code |
| Alternative development setup using other tools or console. | Developed with another tool or via console |
| Troubleshooting related to logging configuration and errors. | Logging troubleshooting |
| Version history, new features, fixes, and changes across releases. | CHANGELOG.md |
📚 Documentation Contents (Others)¶
| Description | Location / Link |
|---|---|
| Software license information. | LICENSE |
| Guidelines for contributors (how to submit PRs, report issues, etc.). | CONTRIBUTING.md → (coming soon) |
| Defines expected behavior for contributors and community interactions. | CODE_OF_CONDUCT.md → (coming soon) |
| High-level overview of the project’s architecture, modules, and dependencies. | Architecture overview → (coming soon) |
| Documentation of public API or module interfaces. | API reference → (coming soon) |
| Instructions for running, writing, and organizing tests. | Testing guide → (coming soon) |
| Steps and checklist for releasing new versions. | Release process → (coming soon) |
| Understanding Docker Tags and Semantic Versioning. | Semantic Versioning → (coming soon) |