beeware / voc

A transpiler that converts Python code into Java bytecode
http://beeware.org/voc
BSD 3-Clause "New" or "Revised" License
869 stars 518 forks source link

VOC is currently on hiatus

The BeeWare project has pivoted away from using VOC for Android development. We now use an embedded CPython library <https://github.com/beeware/Python-Android-support>__ to provide Android support.

We still believe there is value in a bytecode compilation approach; however, we're not dedicating any BeeWare resources to VOC development, and we we're not encouraging other to contribute to VOC at this time.

If you're still interested in working on VOC, please get in touch <https://gitter.im/beeware/general>__.

VOC

.. image:: https://img.shields.io/pypi/pyversions/voc.svg :target: https://pypi.python.org/pypi/voc

.. image:: https://img.shields.io/pypi/v/voc.svg :target: https://pypi.python.org/pypi/voc

.. image:: https://img.shields.io/pypi/status/voc.svg :target: https://pypi.python.org/pypi/voc

.. image:: https://img.shields.io/pypi/l/voc.svg :target: https://github.com/beeware/voc/blob/master/LICENSE

.. image:: https://beekeeper.beeware.org/projects/beeware/voc/shield :target: https://beekeeper.beeware.org/projects/beeware/voc

.. image:: https://badges.gitter.im/beeware/general.svg :target: https://gitter.im/beeware/general

A transpiler that converts Python code into Java bytecode.

This is experimental code. If it breaks, you get to keep all the shiny pieces.

What it does:

It isn't a completely compliant Python 3.4 implementation - there are some language features (some builtin functions) that still need to be implemented, and there is only a bare bones standard library implementation. However, it is possible to convert simple Python programs, and even write simple Android applications.

Tutorial

To take VOC for a spin, run through the Getting Started guide, then start with the first tutorial.

If you'd like to contribute to VOC development, we have a guide for first time contributors_.

.. _Getting Started guide: https://voc.readthedocs.io/en/latest/index.html .. _the first tutorial: https://voc.readthedocs.io/en/latest/tutorial/tutorial-0.html

.. _guide for first time contributors: https://beeware.org/contributing/how/first-time/what/voc/

Documentation

Documentation for VOC can be found on Read The Docs_.

Why "VOC"?

VOC is a backronym for "Vestigial Output Compiler". Or "Vexing Obtuse Compiler". Or "Valuable Obscure Compiler". Or "Varigated Ocelot Calibrator". It's your choice.

Historically, VOC was the Vereenigde Oostindische Compagnie (VOC)_, or Dutch East India Company, often considered to be the world's first multinational corporation. It was also the first company to issue shares, and facilitate the trading of those shares. It was granted a 21 year monopoly to carry out trade activities in Asia, primarily the Spice Islands - the Dutch East Indies. They established a major trading port at Batavia - now Jakarta - on the island of Java (now part of Indonesia).

While VOC was a very profitable business for it's shareholders, it operated as a colonial power. Modern historians have expressed criticism of their business practices_, which included exploitation of indigenous populations (including use of slave labour), slave trade, use of violence, and environmental destruction (including deforestation).

VOC also played a role in the European discovery of Australia, and there are many VOC shipwrecks on the coast of Western Australia.

The name VOC was chosen by the project because the project founder is from Western Australia, and VOC has a strong non-colonial presence in that state's history. It was also a convenient pun, as VOC was an enterprise Java company.

It should not be considered an endorsement or glorification of the exploitative business practices of the company.

.. _Vereenigde Oostindische Compagnie (VOC): https://en.wikipedia.org/wiki/Dutch_East_India_Company .. _expressed criticism of their business practices: https://en.wikipedia.org/wiki/Dutch_East_India_Company#Criticism

Community

VOC is part of the BeeWare suite_. You can talk to the community through:

We foster a welcoming and respectful community as described in our BeeWare Community Code of Conduct_.

Contributing

To get started with contributing to VOC, head over to our First Timers Guide_.

If you experience problems with VOC, log them on GitHub. If you want to contribute code, please fork the code and submit a pull request_.

.. _BeeWare suite: https://beeware.org .. Read The Docs: https://voc.readthedocs.io .. @pybeeware on Twitter: https://twitter.com/pybeeware .. _beeware/general: https://gitter.im/beeware/general .. _BeeWare Community Code of Conduct: https://beeware.org/community/behavior/ .. _First Timers Guide: https://beeware.org/contributing/how/first-time/what/voc/ .. _log them on Github: https://github.com/beeware/voc/issues .. _fork the code: https://github.com/beeware/voc .. _submit a pull request: https://github.com/beeware/voc/pulls