Light

saadmk11 / python-third-party-imports Goto Github PK

View Code? Open in Web Editor NEW

38.0 2.0 0.0 63 KB

A Python CLI tool (Written in Rust) that finds all third-party packages imported into your Python project

Home Page: https://pypi.org/project/third-party-imports/

License: MIT License

Rust 100.00%

cargo cli cli-app import maturin package pip python python-rust python3

python-third-party-imports's Introduction

python-third-party-imports

This is a Python CLI tool built with Rust that finds all third-party packages imported into your Python project.

Install

You can install this package via pip.

pip install third-party-imports

Usage

Run:

Check a directory:

third-party-imports path/to/project/dir

Check a directory with extra files:

third-party-imports --extra-file-paths path/to/project/dir/foo.sh path/to/project/dir

Note: You can use --extra-file-paths option to include files that do not contain .py or .pyi extension.

Check a file:

third-party-imports --project-root path/to/project/dir/ path/to/project/dir/foo/main.py

Note: If the file is not located in the project root directory, then you need to use --project-root option to specify where the project root directory is located.

Help:

Find all third-party packages imported into your python project.

Usage: third-party-imports [OPTIONS] <PATH>

Arguments:
  <PATH>  Path to a file or directory to check

Options:
  -p, --project-root <PROJECT_ROOT>          Path to the project's root directory
  -e, --extra-file-paths <EXTRA_FILE_PATHS>  Extra file paths to check
  -h, --help                                 Print help
  -V, --version                              Print version

Example

third-party-imports examples/

Output:

Found '4' third-party package imports in '5' files. (Took 920.50µs)

celery
django
pandas
requests

Development

Run using Cargo

cargo +nightly run -- path/to/project/dir

Code Format

cargo +nightly fmt

Run Tests

cargo +nightly test

Install Package in current `virtualenv`

maturin develop

License

The code in this project is released under the MIT License.

python-third-party-imports's People

Contributors

Stargazers

Watchers

python-third-party-imports's Issues

'Path must be a directory' error on Windows

Hi,

On Windows 10, when I run the following:

third-party-imports gPython\gremote.py

I get the following:

error: invalid value 'gPython\gremote.py' for '<PROJECT_ROOT>': Path must be a directory

This also happens if I try with forward-slash (as in Linux) or the with the full path.

Thanks!

Executable python files are not scanned

A file with a shebang of #!/usr/bin/env python and no .py extension are not scanned by this tool.

give an option to skip imports for type checking?

Sometimes imports are used only for type checking. Python recommends placing these imports under a if TYPE_CHECKING condition: https://docs.python.org/3/library/typing.html#typing.TYPE_CHECKING, which can be used to reduce the cost of imports during runtime or to break circular dependencies. Is it possible to have an option to exclude these imports?

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.