pycodemap 1.0.0

A CLI tool for extracting and outlining the structure of Python code.

PyCodeMap

Version: 1.0.0

Description

PyCodeMap is a command-line tool to extract and outline the structure of Python code. It helps developers visualize the organization of classes, methods, functions, and attributes in their projects, providing a clear and detailed overview.

Installation

You can install PyCodeMap directly from PyPI:

pip install pycodemap

Usage

After installation, you can run the tool using the pycodemap command.

Basic Commands

• Analyze the current directory:

  pycodemap .
  

• Save the output to a file:

  pycodemap . -o structure.txt
  pycodemap . --output structure.txt
  

• Show only functions:

  pycodemap . -c
  pycodemap . --functions-only
  

• Show only classes:

  pycodemap . -c
  pycodemap . --classes-only
  

• Exclude attributes from the output:

  pycodemap . -a
  pycodemap . --no-attributes
  

• Minimalistic output:

  pycodemap . -m
  pycodemap . --minimalistic
  

• Exclude specific directories or files:

  pycodemap . -i "dir_to_ignore|file_to_ignore"
  pycodemap . --ignore "dir_to_ignore|file_to_ignore"
  

You can combine multiple options to get the desired output.

pycodemap . -cam -i "dir_to_ignore|file_to_ignore"
pycodemap . --classes-only --no-attributes --minimalistic --ignore "dir_to_ignore|file_to_ignore"

Вы правы, в раздел для контрибьюторов обычно включают инструкции по созданию форка репозитория, так как контрибьюторы не всегда имеют прямой доступ для записи в основной репозиторий. Вот исправленная версия с учётом процесса форка и создания pull request:

Contributing

How to contribute

Follow these steps to set up your development environment and submit your changes:

1. Fork the repository:

   • Go to the PyCodeMap repository on GitHub.
   • Click the "Fork" button in the top-right corner to create your own copy of the repository.

2. Clone your forked repository:

   git clone https://github.com/your_username/PyCodeMap.git
   cd PyCodeMap
   

3. Install pycodemap in editable mode from source code:

   pip install -e .
   

   Now you can develop and test your changes locally by running pycodemap. All changes will be automatically reflected in your local installation.

4. Create a new branch for your feature or bugfix:

   git checkout -b your-feature-branch
   

5. Set up pre-commit to ensure code quality:

   pip install pre-commit
   pre-commit install
   

   Before committing your changes, pre-commit checks your code for formatting. If issues are found, the commit process halts, and pre-commit automatically resolves them. You'll need to stage these changes and try to commit again.

6. Make your changes and write tests.

7. Run all tests:

   pytest
   

8. Commit your changes and push them to your forked repository:

   git push origin your-feature-branch
   

9. Create a pull request:

   • Go to the original PyCodeMap repository.
   • Click "Pull Requests" and then "New Pull Request."
   • Select your branch from your forked repository and create the pull request.

Guidelines

• Ensure your code is formatted with black.
• Use isort for imports and autoflake to remove unused imports.
• Check your code with pylint using configuration from .pylintrc.
• Write tests for any new features or bug fixes.
• Provide a clear description of the changes in your pull request.