Skip to content

Commit

Permalink
fix some image issues
Browse files Browse the repository at this point in the history
  • Loading branch information
xmnlab committed Jan 17, 2024
1 parent 6448e4d commit d99e06f
Showing 1 changed file with 2 additions and 33 deletions.
35 changes: 2 additions & 33 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,38 +2,7 @@

# PyUML

PyUML is a tool for handling environment files (e.g. .env) for multiple kind of environments with versioning
PyUML is a tool for creating UML diagrams from python source code.

- License: BSD 3 Clause
- Documentation: https://pyuml.github.io

## Features

- The security of our code: Bandit is a powerful tool that we use in our Python
project to ensure its security. This tool analyzes the code and detects
potential vulnerabilities. Some of the key features of Bandit are its ease of
use, its ability to integrate with other tools, and its support for multiple
Python versions. If you want to know about bandit you can check its
[documentation](https://bandit.readthedocs.io/en/latest/).

- Finds unused code: [Vulture](https://github.com/jendrikseipp/vulture)
is useful for cleaning up and finding errors in large code bases in
Python.

- Complexity of functions and modules: We use
[McCabe](https://github.com/PyCQA/mccabe) to identify the complexity in our
Python code that may be difficult to maintain or understand. By identifying
complex code at the outset, we as developers can refactor it to make it easier
to maintain and understand. In summary, McCabe helps us to improve the quality
of our code and make it easier to maintain. If you would like to learn more
about McCabe and code complexity, you can visit [McCabe - Code Complexity
Checker](https://here-be-pythons.readthedocs.io/en/latest/python/mccabe.html).
This tool is included with [Flake8](https://flake8.pycqa.org/en/latest/).

- TODO

## Credits

This package was created with Cookieninja and the
[osl-incubator/scicookie](https://github.com/osl-incubator/scicookie)
project template.
- Documentation: https://osl-incubator.github.io/pyuml

0 comments on commit d99e06f

Please sign in to comment.