Skip to main content

Snake Me Please is a Python package and command-line tool designed to convert user-defined variable names to snake_case in Python files while excluding imported variables and keywords from Python libraries.

Project description

Snake Me Please

Snake Me Please is a Python package and command-line tool designed to convert user-defined variable names to snake_case in Python files while excluding imported variables and keywords from Python libraries.

Installation

Install the package using pip:

pip install snake-me-please

Usage

Convert a Single File

To convert user-defined variables to snake_case in a single Python file, use the following command:

snake-me-please your_python_file.py

Convert Files in a Directory

To convert user-defined variables in all Python files within a directory, use the following command:

snake-me-please your_directory

Display Conversion Results

The tool will display unique conversions and exclude imported variables or Python keywords.

Example

snake-me-please examples/

This will process all Python files in the examples directory and display the conversion results.

License

This project is licensed under the GNU General Public License - see the LICENSE file for details.

Contributing

Feel free to contribute to this project. For major changes, please open an issue first to discuss what you would like to change. Acknowledgments

Inspired by the need for consistent naming conventions in Python code.
Thanks to the open-source community for valuable contributions.

Contact

For any inquiries, please contact Aditya Jetely.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

snake_me_please-0.5.tar.gz (15.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

snake_me_please-0.5-py3-none-any.whl (16.1 kB view details)

Uploaded Python 3

File details

Details for the file snake_me_please-0.5.tar.gz.

File metadata

  • Download URL: snake_me_please-0.5.tar.gz
  • Upload date:
  • Size: 15.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for snake_me_please-0.5.tar.gz
Algorithm Hash digest
SHA256 14ffa23a23bb7b3191a64ead8a0241a8ef2fcbee8087880e88ba9030b5ab6907
MD5 0c21b54f7f64478a0484e32472458a9b
BLAKE2b-256 b1c3ec0799e9c830f84773f02e49b8b5eea97a74df49934bddc7bbe8d88de310

See more details on using hashes here.

File details

Details for the file snake_me_please-0.5-py3-none-any.whl.

File metadata

  • Download URL: snake_me_please-0.5-py3-none-any.whl
  • Upload date:
  • Size: 16.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for snake_me_please-0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 bfee8dd2f04111432ac2e8feee343d9af7df96cf83871776abf77014a984044a
MD5 cb783d80d32c83df0c9e504f56f74c31
BLAKE2b-256 eafc99c292293a62b18ccf4fea065cf2bc2ff134258486eb56d7687bfb65e3b6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page