Skip to content

Latest commit

 

History

History
83 lines (70 loc) · 3.38 KB

README.md

File metadata and controls

83 lines (70 loc) · 3.38 KB
Raw

Welcome to PyWeb3D

what is PyWeb3D

In summary PyWeb3D is three.js with python syntax.

Read documentation.

Aim of PyWeb3d

  • To extend the three.js library and enable python developers to build 3D web applications (without or with basic knowledge of JavaScript)
  • To build a powerful 3D web framework for creating full fledged 3D stores and web applications

Current Priorities

  • Writing a detailed python documentation
  • Modify and Include all files in /jsm directory of three.js
  • Add more examples to the documentation

Try PyWeb3D

You can use PyWeb3D without having to install anything.

Add the necessary libraries and packages into the <head></head> tag of your HTML file.

<head>     
	<script src="https://cdn.jsdelivr.net/npm/brython@3.10.7/brython.min.js"></script>
	<script src="https://cdn.jsdelivr.net/npm/brython@3.10.7/brython_stdlib.js"></script>
	<script src="https://unpkg.com/three@0.145.0/build/three.js"></script>
	<script src="https://www.pyweb3d.org/pyweb3d/v1.0.0/pyweb3d.brython.js"></script>
</head>

Note the three.js that's been used, not the module version

Here's a HTML boilerplate:

<!DOCTYPE html>
<html>
  <head>
	<meta charset="utf-8">
	<title>My first pyWeb3D app</title>
	<script src="https://cdn.jsdelivr.net/npm/brython@3.10.7/brython.min.js"></script>
	<script src="https://cdn.jsdelivr.net/npm/brython@3.10.7/brython_stdlib.js"></script>
	<script src="https://unpkg.com/three@0.145.0/build/three.js"></script>
	<script src="https://www.pyweb3d.org/pyweb3d/v1.0.0/pyweb3d.brython.js"></script>
	<style>
	    body { margin: 0; }
	</style>
 </head>
 <body onload="brython(1)">
	<script type="text/python">
		from browser import document, window
		from  pyweb3d.pyweb3d import *
		...
	</script>
 </body>
</html>

Check out the the examples directory folder for more examples on how to use pyWeb3D, all you need to do is open the HTML file in your browser.

How to Contribute

If you like this project, please consider helping out. All contributions are welcome as well as donations to Patreon or in Crypto
BTC: bc1qr4e3k6gpk5h82nduttzfq6lt5pnlkxpdjs98rp
DogeCoin: D7pr1DgNBEV5m5DrHNULFMcE1so5MvA945
BNB(Smart Chain): 0xa12E5b6370aDc7E714Fb8D901dA2631f22eDb0a5

  • Fork the repository - quicklink
  • Clone the forked repository to your local system.
  • Add a Git remote for the original repository.
  • Create a feature branch in which to place your changes.
  • Check the issues list for something to do or add your feature
  • Make your changes to the new branch.
  • Commit the changes to the branch.
  • Push the branch to GitHub.
  • Open a pull request from the new branch to the original repo.
  • Clean up after your pull request is merged.

refer to this article for detailed explanation on the workflow

PyWeb3D Articles to read:

Credits and references