django-cythonizer

v0.0.12

A Django package for Cythonizing Django projects For more information about how to use this package see README

Latest version published 4 months ago

License: MIT License with Usage Disclo…

PyPI

GitHub

Package Health Score

57 / 100

security
Security review needed
popularity
Limited
maintenance
Sustainable
community
Sustainable

Explore Similar Packages

CherryPy
85

Popularity

Limited

GitHub Stars: 0
Forks: 0
Contributors: 1

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package django-cythonizer, we found that it has been starred ? times.

Security

Security review needed

Security and license risk for latest version

Release Date: Jul 19, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
0
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

MIT License with Usage Disclosure Copyright (c) 2024 Salah Aldain Alhajj Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: 1. The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. 2. Users of this Software must disclose the use of django-cythonizer in their project documentation or in a file named THIRD-PARTY-NOTICES (or similar) that accompanies the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Security Policy

We found a way for you to contribute to the project! Looks like django-cythonizer is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Sustainable

Commit Frequency

Open Issues: 0
Open PR: 0
Last Release: 4 months ago
Last Commit: 4 months ago

Further analysis of the maintenance status of django-cythonizer based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that django-cythonizer demonstrates a positive version release cadence with at least one new version released in the past 12 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Sustainable

Readme: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 1
Funding: No

This project has seen only 10 or less contributors.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: >=3.6

Age: 4 months
Latest Release: 4 months ago
Dependencies: 1 Direct / 5 Total
Versions: 2
Maintainers: 1
Wheels: OS Independent

Readme

Django-Cythonizer 🚀

Django-Cythonizer Logo

Supercharge your Django project with the power of Cython! 🐍💨

🌟 Features

🚀 Automatically compile Django views and models to Cython
📈 Boost performance by up to 30% (results may vary)
🛠 Easy integration with existing Django projects
🔒 Secure your Python source code
🔧 Customizable compilation settings

🚀 Quick Start

Installation

pip install django-cythonizer

Usage

Add 'cythonizer' to your INSTALLED_APPS:

INSTALLED_APPS = [
    # ...
    'cythonizer',
    # ...
]

Run the cythonize command:

python manage.py cythonize

Open build FLoder and run it as normal django project
Enjoy the speed boost! 🎉🎉🎉🎉

⚠️ Important Considerations

Handling Excluded Paths

Virtual Environments: The .venv directory is excluded by default.
Migration Files: The migrations folders are excluded to avoid issues with Django's migration system.
Configuration Files: Sensitive files like settings.py and urls.py are excluded.

Other Considerations

Always test your project after compilation to ensure no unexpected errors occur.
Keep a backup of your original code before applying compilation on a large scale.

🔧 Configuration

The settings.yaml file in your project root controls the cythonizer behavior:

build:
  path: 'build'

exclude:
  files:
    - 'setup.py'
    - '__init__.py'
    - 'manage.py'
    - 'urls.py'
    - '.gitigonre'
    - '.git'
  dirs:
    - 'migrations'
    - '.venv'
    - 'build'

# ... (other settings)

🔥 Performance Comparison

Here's a quick benchmark comparing a standard Django view vs a Cythonized view:

Scenario	Requests/sec	Latency (ms)
Standard	1000	50
Cythonized	1300	38

As the load increases on the system, the performance and reliability gap between the standard Django project and the Cythonized Django project widens, with the Cythonized version consistently outperforming, despite both projects being identical in terms of code and environment.

🛠 How It Works

Analysis: Django-Cythonizer scans your project structure.
Compilation: It compiles eligible Python files to Cython.
Integration: The compiled modules seamlessly replace the original ones.
Optimization: Enjoy the performance benefits!

🤔 FAQs

Is it compatible with all Django versions?

Django-Cythonizer supports Django 3.2 and above, as specified in the project requirements.

Will it break my existing code?

No, Django-Cythonizer is designed to be non-intrusive. Your original Python files remain untouched.

Can I use it in production?

Absolutely! Many projects use Cython in production to great effect. Always thoroughly test before deploying.

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for more details.

📜 License

Django-Cythonizer is released under the MIT License. See the LICENSE file for more details.

🙏 Acknowledgements

The amazing Django community
The Cython team for their incredible work
All our contributors and users

📬 Contact

For support or queries, reach out to us at contact@salahaldain.com.

Made with ❤️ by developers, for developers.
Initiated by Salah Aldain Alhajj

django-cythonizer dependencies

djangorestframework

FAQs

What is django-cythonizer?

A Django package for Cythonizing Django projects. Visit Snyk Advisor to see a full health score report for django-cythonizer, including popularity, security, maintenance & community analysis.

Is django-cythonizer popular?

We’re still processing downloads data for the python package django-cythonizer. Visit the popularity section on Snyk Advisor to see the full popularity analysis.

Is django-cythonizer well maintained?

We found indications that django-cythonizer maintenance is sustainable demonstrating some project activity. We saw a total of 1 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is django-cythonizer safe to use?

While scanning the latest version of django-cythonizer, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 14 November-2024, at 03:54 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP