You write in Python, it compiles to Javascript #Made with ❤️ from west indies
Project description
django-papaye
This package installs helps help you use Transcrypt in Django.
It gives you new terminal commands and configures all you need inside any Django project, so you're all set to go.
- Description
- Usage
- Installation
- System Requirements
- Testing
- Development/Contributing
- History
- Donations
- Licence
- Todo and Possible Future Improvements
- FAQ
Package Description
django-papaye package configures your Django project in order to let you use Transcrypt into it the better way as possible.
Usage
In a Script - purely for development
Assuming you already created a Django project at '/path/to/your/django/project' (if not please do so)
Before installing django-papaye you MUST first:
-
Install pyenv: https://github.com/pyenv/pyenv
-
Install a python3.9 version via pyenv:
pyenv install 3.9.19
- In a new terminal tab, create a specific python virtual environment via pyenv:
cd /path/to/your/django/project # go to you django project root folder (same folder where manage.py is)
pyenv shell 3.9.19 # switches to this specific version of python for this terminal tab until it's closed
python3 --version # it should print out 'Python 3.9.19'
python3 -m venv venv-3.9
source venv-3.9/bin/activate # to activate your venv-3.9
- Install django-papaye:
pip install django-papaye
- Then configure your django transcrypt environment by executing this command:
configure
- Add a "load static" statement at top of base.html, then add a "script" calling your code transpiled from Python to Javascript just before the end of body tag:
{% load static %}
<body>
...
{# Transcrypted from .py to .js #}
<script src="{% static 'js/main.js' %}"></script>
</body>
- Start the Transcrypt Python2JS development server:
npm run devDesktop
- Add the following code to t_logic/main.py:
print('Hello from Transcrypt and django-papaye!')
- Reload your browser with ctrl+shift+r, then open "inspect", then go "Console" tab and you should see the content of your print coded at previous step.
Your all good to go now! 🥭
Installation
Install the package with:
pip install django-papaye
System Requirements
Must have linux. You can prob change easily to support other OSes, but not currently supported
Testing
Run tests on install by doing:
pip3 install lib_off_campus_housing_parser --force --install-option test
This will install the package, force the command line arguments to be installed, and run the tests
NOTE: You might need sudo to install command line arguments when doing this
You can test the package if in development by moving/cd into the directory where setup.py is located and running:
python3 setup.py test
To test a specific submodule, cd into that submodule and run:
pytest
Note: I currently have not written any tests, since I have tried the program and checked it's output by hand so I know that it works. I know that this is not sufficient, but no one is going to use this thing but me so whatevs.
Development/Contributing
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature - Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request
- Email me at guyyann.vectol@gmail.com because I do not check those messages often
History
-
- 0.1.13 - Quick fix on README.md
- 0.1.12 - Changes on README.md
- 0.1.11 - Added import main.js in base.html on README.md
- 0.1.10 - New changes on README.md
- 0.1.9 - New changes on README.md
- 0.1.8 - Changes on README.md
- 0.1.7 - Enabled README.md for Pypi
- 0.1.6 - Add a donation link inside README.md
- 0.1.5 - Another quick fix on README.md
- 0.1.4 - Quick fix on README.md
- 0.1.3 - Added a link to Github
- 0.1.2 - Added README.md
- 0.1.1 - Changes to include necessary files and folders
Donations
https://www.paypal.com/donate/?hosted_button_id=8BWT6CHREL5CE
License
BSD License
Copyright 2024 qlapp
Contributors: Guy-Yann VECTOL
Citation: "As-tu déjà ouvert une papaye? Au premier abord ça pue. Mais ensuite tu y goutes et tu te rends compte que c'est super bon ;)"
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
-
Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
TODO/Possible Future Improvements
-
Todo and Possible Future Improvements
- Actual testing
- Cross platform compatibility
FAQ
Q: Why this name: django-papaye ?
A1: Have you ever opened a 'papaye' 🥭?
It smells very bad! => like using Transcrypt inside Django at first
But then you start to taste it and now you are getting in love with it. Guess what, same for Transcrypt inside Django
P.S.: Fruits 4 life 🔆🌱🥭💪!
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file django_papaye-0.1.13-py3-none-any.whl.
File metadata
- Download URL: django_papaye-0.1.13-py3-none-any.whl
- Upload date:
- Size: 11.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.9.19
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f04d9c78fb95febd3ecdea905a6ae9999fcd466159bc1d5754a0948ea489a433
|
|
| MD5 |
d80555cb27e300ea7c78d434b836b1d8
|
|
| BLAKE2b-256 |
c547189c47572cf44d9589c9dfddb1dbd6ae6e712902acc786b2e87ae0bace2d
|
