Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joaopalmeiro/flake8-import-conventions
An opinionated plugin for Flake8 on how certain packages should be imported or aliased.
https://github.com/joaopalmeiro/flake8-import-conventions
flake8 flake8-plugin
Last synced: 3 months ago
JSON representation
An opinionated plugin for Flake8 on how certain packages should be imported or aliased.
- Host: GitHub
- URL: https://github.com/joaopalmeiro/flake8-import-conventions
- Owner: joaopalmeiro
- License: mit
- Created: 2021-03-10T22:28:28.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-14T14:34:43.000Z (about 1 year ago)
- Last Synced: 2024-06-19T03:11:46.232Z (5 months ago)
- Topics: flake8, flake8-plugin
- Language: Python
- Homepage: https://pypi.org/project/flake8-import-conventions/
- Size: 1.41 MB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-flake8-extensions - flake8-import-conventions - How certain packages should be imported or aliased. (Imports)
README
# flake8-import-conventions
[](https://pypi.org/project/flake8-import-conventions/)
An opinionated plugin for Flake8 on how certain packages should be imported or aliased.
It is based on the [`pandas-vet`](https://github.com/deppen8/pandas-vet) and [`flake8-2020`](https://github.com/asottile/flake8-2020) plugins.
## Installation
Via [Pipenv](https://pipenv.pypa.io/):
```bash
pipenv install --dev flake8 flake8-import-conventions
```
## Flake8 codes
| Package | Code | Description |
| ------------------------------------------- | ----- | ------------------------------------------------------------------------------ |
| [Altair](https://altair-viz.github.io/) | IC001 | altair should be imported as `import altair as alt` |
| [GeoPandas](https://geopandas.org/) | IC002 | geopandas should be imported as `import geopandas` |
| [Matplotlib](https://matplotlib.org/) | IC003 | matplotlib.pyplot should be imported as `import matplotlib.pyplot as plt` |
| [NetworkX](https://networkx.org/) | IC004 | networkx should be imported as `import networkx as nx` |
| [NumPy](https://numpy.org/) | IC005 | numpy should be imported as `import numpy as np` |
| [pandas](https://pandas.pydata.org/) | IC006 | pandas should be imported as `import pandas as pd` |
| [Plotly](https://plotly.com/python/) | IC007 | plotly.express should be imported as `import plotly.express as px` |
| [Plotly](https://plotly.com/python/) | IC008 | plotly.graph_objects should be imported as `import plotly.graph_objects as go` |
| [seaborn](https://seaborn.pydata.org/) | IC009 | seaborn should be imported as `import seaborn as sns` |
| [statsmodels](https://www.statsmodels.org/) | IC010 | statsmodels.api should be imported as `import statsmodels.api as sm` |
## Development
```bash
poetry install --with dev
```
```bash
poetry shell
```
Open the `manual_test.py` file in VS Code to see the error messages.
```bash
pytest tests/ -v
```
or (to see `print()`s)
```bash
pytest tests/ -v -s
```
Copy the output of the following script and paste it in the [Flake8 codes](#flake8-codes) section:
```bash
python gen_table.py
```
If changes are not reflected in VS Code after changing something in the package, close it and open it again.
## Deployment
```bash
poetry check
```
```bash
poetry version minor
```
or
```bash
poetry version patch
```
Commit the change in the `pyproject.toml` file.
```bash
git tag
```
```bash
git tag "v$(poetry version --short)"
```
```bash
git push origin "v$(poetry version --short)"
```
## References
- Anthony Sottile's "[a flake8 plugin from scratch (intermediate) anthony explains #025](https://youtu.be/ot5Z4KQPBL8)" tutorial.
- [flake8-pie](https://github.com/sbdchd/flake8-pie).
- [wemake-python-styleguide](https://github.com/wemake-services/wemake-python-styleguide).