Intro

Starting a new Python project is always a mix of excitement and challenge. Whether you're a seasoned developer or just getting your feet wet, the right tools can significantly boost your productivity and the quality of your code. With development practices and tools continuously evolving, it's essential to stay updated with the best utilities available.

In 2024, several tools have become indispensable for Python developers, particularly for professional projects. In this blog post, I want to share some of the essential tools that I always use when starting a new Python project. These tools not only streamline the development process but also enhance code quality and maintainability. Let’s dive in!

---

GitLens

GitLens is an extension for Visual Studio Code that supercharges the built-in Git capabilities. When working in teams, GitLens makes easy to understand the codebase history and the choices made by the other team members, providing context and rationale for the changes.

Benefits:

• Rich Insights: Provides detailed information about code authorship and history.

• Enhanced Blame Feature: Allows you to see who made changes to a specific line of code.

• Visualization: Offers graphical representations of code evolution.

SonarLint

SonarLint is a code quality and security tool that performs real-time code analysis in your IDE.

Benefits:

• Immediate Feedback: Identifies coding issues as you type.

• Security: Highlights potential vulnerabilities in your code.

• Guidance: Provides detailed explanations and suggestions for fixes.

Scenario: While coding a new feature, SonarLint highlights a potential security flaw. You can address it immediately, ensuring your code remains secure from the outset.

Pyright

Pyright is a static type checker for Python, developed by Microsoft.

If you've worked on larger Python projects, you've probably encountered frustrating type errors that seem to appear out of nowhere. Pyright can be a lifesaver in these situations. By catching type-related issues early, it helps ensure that your types are consistent throughout your code. This can be particularly beneficial when working on complex functions that handle multiple data types, making your code more reliable and reducing those late-night debugging sessions.

Benefits:

• Fast and Accurate: Provides quick type checking and error detection.

• Type Annotations: Supports PEP 484-compliant type annotations.

• Early Error Detection: Catches type-related errors during development.

Ruff

Usage: Ruff is an extremely fast Python linter and formatter, written in Rust. With over 800 built-in rules, you don't need to use multiple packages to lint and format your project anymore. Also, if your codebase has thousands of lines. Ruff’s speed ensures that linting doesn’t slow down your development process, providing quick feedback on coding standards and potential issues.

Benefits:

• Performance: Offers high-speed linting, ideal for large codebases.

• Consistency: Enforces coding standards and best practices.

• Error Detection: Identifies potential bugs and style issues.

Sourcery

Sourcery is an AI-powered coding assistant that can refactors your Python code automatically. While coding, Sourcery reviews and suggests a more efficient way to write the code. Accepting its suggestion generally makes your code more Pythonic and improves performance.

Benefits:

• Code Quality: Suggests improvements to make your code cleaner and more readable.

• Real-time Suggestions: Provides instant feedback as you write code.

• Productivity: Reduces the time spent on manual code reviews and refactoring.

PDM

PDM (Python Dependency Management) is a modern Python package and dependency manager.
Setting up a new project becomes straightforward with PDM. You can quickly manage dependencies without worrying about virtual environments, reducing setup time and potential errors.

Benefits:

• Simplicity: Simplifies the management of project dependencies and environments.

• PEP 582 Support: Stores dependencies within the project directory, eliminating the need for virtual environments.

• Efficiency: Streamlines the setup process for new projects.

Pre-commit

Pre-commit is a framework for managing and maintaining multi-language pre-commit hooks. Before pushing changes to the repository, Pre-commit can run a series of checks, including linting, formatting, unit tests, ensuring that only high-quality code is committed.

One common use case is when you need to ensure that every commit message includes the issue ID from the branch name. By setting up a pre-commit hook, you can automate this process. For example, if your branch name is ISS-13-blablabla, the hook can automatically prefix your commit messages with ISS-123:, ensuring consistency and adherence to your project's commit message standards.

Benefits:

• Consistency: Ensures that code meets your quality standards before it gets committed.

• Automation: Runs automated checks on your code before it is committed to the repository.

• Customization: Supports custom hooks to enforce your specific coding guidelines.

Visual Studio Code (VS Code)

VS Code is a powerful, lightweight code editor that has become a favorite among developers.

Benefits:

• Extensibility: Rich ecosystem of extensions to enhance functionality.

• Debugging: Integrated debugging tools.

• Customization: Highly customizable to fit individual workflows.

• Intelligent Features: Supports syntax highlighting, intelligent code completion, snippets, and refactoring.

---

Conclusion

Starting a new Python project can be an overwhelming task, but with the right tools at your disposal, the process becomes much more manageable.

GitLens, SonarLint, Pyright, Ruff, Sourcery, PDM, Pre-commit, and VS Code are some of the tools that I rely on to ensure my projects are well-structured, maintainable, and of high quality. By integrating these tools into your workflow, you can boost your productivity and write better code. Happy coding!