Skip to content

Commit

Permalink
Logo (#101)
Browse files Browse the repository at this point in the history
* added logo
  • Loading branch information
Florian Maas authored Sep 13, 2022
1 parent aaec423 commit d9aef9c
Show file tree
Hide file tree
Showing 3 changed files with 429 additions and 13 deletions.
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# deptry
<p align="center">
<img width="460" height="300" src="docs/docs/static/deptry_Logo-01.svg">
</p>

---

[![Release](https://img.shields.io/github/v/release/fpgmaas/deptry)](https://img.shields.io/github/v/release/fpgmaas/deptry)
[![Build status](https://img.shields.io/github/workflow/status/fpgmaas/deptry/merge-to-main)](https://img.shields.io/github/workflow/status/fpgmaas/deptry/merge-to-main)
Expand All @@ -7,8 +11,6 @@
[![PyPI - Downloads](https://img.shields.io/pypi/dm/deptry)](https://img.shields.io/pypi/dm/deptry?style=flat-square)
[![License](https://img.shields.io/github/license/fpgmaas/deptry)](https://img.shields.io/github/license/fpgmaas/deptry)

---

_deptry_ is a command line tool to check for issues with dependencies in a Python project, such as obsolete or missing dependencies. It supports the following types of projects:

- Projects that use [Poetry](https://python-poetry.org/) and a corresponding _pyproject.toml_ file
Expand All @@ -17,8 +19,9 @@ _deptry_ is a command line tool to check for issues with dependencies in a Pytho
Dependency issues are detected by scanning for imported modules within all Python files in a directory and its subdirectories, and comparing those to the dependencies listed in the project's requirements.

---

**Documentation**: <https://fpgmaas.github.io/deptry/>
<p align="center">
<a href = "https://fpgmaas.github.io/deptry">Link to the documentation</a>
</p>

---

Expand Down Expand Up @@ -48,7 +51,7 @@ _deptry_ should be run withing the root directory of the project to be scanned,

### Usage

To scan your project for obsolete imports, run
To scan your project for dependency issues, run

```sh
deptry .
Expand Down
18 changes: 11 additions & 7 deletions docs/docs/index.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,22 @@

# deptry
<p align="center">
<img width="460" height="300" src="static/deptry_Logo-01.svg">
</p>
<style>
.md-typeset h1,
.md-content__button {
display: none;
}
</style>

---

[![Release](https://img.shields.io/github/v/release/fpgmaas/deptry)](https://img.shields.io/github/v/release/fpgmaas/deptry)
[![Build status](https://img.shields.io/github/workflow/status/fpgmaas/deptry/merge-to-main)](https://img.shields.io/github/workflow/status/fpgmaas/deptry/merge-to-main)
[![Supported Python versions](https://img.shields.io/pypi/pyversions/deptry)](https://pypi.org/project/deptry/)
[![codecov](https://codecov.io/gh/fpgmaas/deptry/branch/main/graph/badge.svg)](https://codecov.io/gh/fpgmaas/deptry)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/deptry)](https://img.shields.io/pypi/dm/deptry?style=flat-square)
[![License](https://img.shields.io/github/license/fpgmaas/deptry)](https://img.shields.io/github/license/fpgmaas/deptry)
---

_deptry_ is a command line tool to check for issues with dependencies in a Python project, such as obsolete or missing dependencies. It supports the following types of projects:

Expand All @@ -19,10 +27,6 @@ Dependency issues are detected by scanning for imported modules within all Pytho

---

**Documentation**: <https://fpgmaas.github.io/deptry/>

---

## Quickstart

### Installation
Expand All @@ -49,7 +53,7 @@ _deptry_ should be run withing the root directory of the project to be scanned,

### Usage

To scan your project for obsolete imports, run
To scan your project for dependency issues, run

```sh
deptry .
Expand Down
Loading

0 comments on commit d9aef9c

Please sign in to comment.