Skip to content

JoshuaDuma/ExtendedDiagramIcons

Repository files navigation

Diagram Icons Extention

license pypi version contributors

Buy Me A Coffee

This repo contains the python library used to create the pip package ExtendedDiagramIcons to extend the Diagrams package: Diagrams GitHub Repository.

Current Builds

Stable Build Version Development Build Version

  • Install latest stable build: pip install ExtendedDiagramIcons==1.2.4

Usage

This is intended to be used in a project that uses the diagrams python pip package as an extention of the available icons. To import the latest build of this library into your project use pip install ExtendedDiagramIcons.

Requirement

  • Python 3.9+
  • Requires the pip package `Diagrams``

Testing

To run the unit tests use this command in the directory python3 -m unittest discover tests.

Publish

To publish the latest version of this project use the following:

  1. Install Twine: pip install twine
  2. Build your package: python setup.py sdist bdist_wheel
  3. To Upload your package, you will need your PyPI credentials (not avilable via CICD for security reasons): twine upload dist/* -u __token__ -p <your-api-token>

Documentation

Use the references below to extend your diagrams. Example import: from ExtendedDiagramIcons.diagrams.octopusdeploy.octopusdeploy import Octopus_Server_Node, Pipeline.

digitalocean

Project ExtendedDiagramIcons.digitalocean.Project

generic

Github ExtendedDiagramIcons.generic.Github

Jira ExtendedDiagramIcons.generic.Jira

Report_Portal ExtendedDiagramIcons.generic.Report_Portal

Software_Engineer ExtendedDiagramIcons.generic.Software_Engineer

dnsproviders.namecheap

Namecheap_Api ExtendedDiagramIcons.dnsproviders.namecheap.Namecheap_Api

Namecheap_Domain ExtendedDiagramIcons.dnsproviders.namecheap.Namecheap_Domain

Provider ExtendedDiagramIcons.dnsproviders.namecheap.Provider

octopusdeploy

Octopus_Deploy ExtendedDiagramIcons.octopusdeploy.Octopus_Deploy

Octopus_Server_Node ExtendedDiagramIcons.octopusdeploy.Octopus_Server_Node

Octopus_Worker_Node ExtendedDiagramIcons.octopusdeploy.Octopus_Worker_Node

Octopus_Worker_Pool ExtendedDiagramIcons.octopusdeploy.Octopus_Worker_Pool

Pipeline ExtendedDiagramIcons.octopusdeploy.Pipeline

Release ExtendedDiagramIcons.octopusdeploy.Release

Semantic Release

GitHub Actions GitHub Actions

Continuous Integration (CI)

GitHub Actions

We use GitHub Actions to automate our release workflows. The badge above indicates the status of our latest build.

Semantic Versioning in Our Project

In our project, we adhere to Semantic Versioning to standardize version numbers and to convey meaning about the underlying code with each release. Below is an explanation of the prefixes we use in our commit messages and how they relate to our release strategy: