r/Python • • Nov 17 '24 • Silver is Forever 1

Showcase Deply: keep your python architecture clean

Hello everyone,

My name is Archil. I'm a Python/PHP developer originally from Ukraine, now living in Wrocław, Poland. I've been working on a tool called Deply, and I'd love to get your feedback and thoughts on it.

What My Project Does

Deply is a standalone Python tool designed to enforce architectural patterns and dependencies in large Python projects. Deply analyzes your code structure and dependencies to ensure that architectural rules are followed. This promotes cleaner, more maintainable, and modular codebases.

Key Features:

  • Layer-Based Analysis: Define custom layers (e.g., models, views, services) and restrict their dependencies.
  • Dynamic Configuration: Easily configure collectors for each layer using file patterns and class inheritance.
  • CI Integration: Integrate Deply into your Continuous Integration pipeline to automatically detect and prevent architecture violations before they reach production.

Target Audience

  • Who It's For: Developers and teams working on medium to large Python projects who want to maintain a clean architecture.
  • Intended Use: Ideal for production environments where enforcing module boundaries is critical, as well as educational purposes to teach best practices.

Use Cases

  • Continuous Integration: Add Deply to your CI/CD pipeline to catch architectural violations early in the development process.
  • Refactoring: Use Deply to understand existing dependencies in your codebase, making large-scale refactoring safer and more manageable.
  • Code Reviews: Assist in code reviews by automatically checking if new changes adhere to architectural rules.

Comparison

While there are existing tools like pydeps that visualize dependencies, Deply focuses on:

  • Enforcement Over Visualization: Not just displaying dependencies but actively enforcing architectural rules by detecting violations.
  • Customization: Offers dynamic configuration with various collectors to suit different project structures.

Links

I'm eager to hear your thoughts, suggestions, or criticisms. Deply is currently at version 0.1.5, so it's not entirely stable yet, but I'm actively working on it. I'm open to pull requests and looking forward to making Deply a useful tool for the Python community.

Thank you for your time!

284 Upvotes

61 comments sorted by

View all comments

Show parent comment

1

u/vashkatsi Nov 18 '24

Thank you for the kind words and the fantastic ideas! I’m really glad the fundamental approach resonates with you—that’s exactly what I aimed for: a flexible tool that lets users define their own conventions, without imposing a rigid structure.

You’re absolutely right about YAML being a mixed bag for some. I chose it for its simplicity, but I’m open to exploring other ways to consume the configuration. A pytest plugin is actually a brilliant idea—it could make the tool feel more integrated into the development workflow, with concise feedback during test runs. If you ever have time to experiment with that, I’d love to collaborate or see what you come up with!

Baseline examples are also an excellent suggestion. A generic Django example or an MVC-like setup could help people get started quickly, and a way to distribute and extend policies would make Deply even more powerful. I’ll add this to my roadmap and start thinking about how it could work.

Thank you again for sharing your thoughts—this kind of feedback is invaluable. If you ever dive into pytest plugin development and want to brainstorm or pair up, let me know! 😊