Latest Threat Research:SANDWORM_MODE: Shai-Hulud-Style npm Worm Hijacks CI Workflows and Poisons AI Toolchains.Details →
beeware
Artifacts are distributable versions of a package. It typically includes the source code and metadata
Advanced tools
beeware - npm Package Compare versions
Sorry, the diff of this file is not supported yet
| sphinx | ||
| sphinxcontrib-spelling | ||
| pyenchant | ||
| sphinx-autobuild | ||
| sphinx_rtd_theme | ||
| sphinx_tabs |
| Metadata-Version: 2.1 | ||
| Name: beeware | ||
| Version: 0.3.0.dev3 | ||
| Version: 0.3.0 | ||
| Summary: A metapackage to install the full BeeWare suite of tools. | ||
@@ -38,4 +38,4 @@ Home-page: http://beeware.org/ | ||
| .. image:: https://github.com/beeware/beefore/workflows/Build%20status/badge.svg | ||
| :target: https://github.com/beeware/beefore/actions | ||
| .. image:: https://github.com/beeware/beeware/workflows/CI/badge.svg?branch=master | ||
| :target: https://github.com/beeware/beeware/actions | ||
| :alt: Build Status | ||
@@ -51,3 +51,3 @@ | ||
| For a introduction to the full BeeWare suite, we recommend running the | ||
| For an introduction to the full BeeWare suite, we recommend running the | ||
| `BeeWare Tutorial`_. | ||
@@ -95,3 +95,3 @@ | ||
| Classifier: Topic :: Utilities | ||
| Requires-Python: >= 3.5 | ||
| Requires-Python: >=3.5 | ||
| Description-Content-Type: text/x-rst; charset=UTF-8 |
@@ -1,2 +0,1 @@ | ||
| briefcase>=0.3.0.dev3 | ||
| toga>=0.3.0.dev17 | ||
| briefcase>=0.3.0 |
@@ -18,5 +18,5 @@ AUTHORS | ||
| docs/make.bat | ||
| docs/requirements.txt | ||
| docs/requirements_docs.txt | ||
| docs/spelling_wordlist | ||
| docs/images/beeware.png | ||
| docs/_static/images/beeware.png | ||
| docs/tutorial/tutorial-0.rst | ||
@@ -23,0 +23,0 @@ docs/tutorial/tutorial-1.rst |
+9
-10
@@ -1,3 +0,1 @@ | ||
| # -*- coding: utf-8 -*- | ||
| # | ||
| # BeeWare documentation build configuration file, created by | ||
@@ -14,7 +12,9 @@ # sphinx-quickstart on Sat Jul 27 14:58:42 2013. | ||
| import os | ||
| import re | ||
| import sys | ||
| # If extensions (or modules to document with autodoc) are in another directory, | ||
| # add these directories to sys.path here. If the directory is relative to the | ||
| # documentation root, use os.path.abspath to make it absolute, like shown here. | ||
| import sys | ||
| import os | ||
@@ -28,3 +28,3 @@ # -- General configuration ----------------------------------------------------- | ||
| # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. | ||
| extensions = ['sphinx.ext.autodoc', 'sphinx.ext.napoleon', 'sphinx.ext.todo', 'sphinx_tabs.tabs'] | ||
| extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx_tabs.tabs'] | ||
@@ -52,4 +52,3 @@ # Add any paths that contain templates here, relative to this directory. | ||
| # The full version, including alpha/beta/rc tags. | ||
| import io, re | ||
| with io.open('../setup.cfg', encoding='utf8') as version_file: | ||
| with open('../setup.cfg', encoding='utf8') as version_file: | ||
| version_match = re.search(r"^version = (.*)$", version_file.read(), re.M) | ||
@@ -109,3 +108,3 @@ if version_match: | ||
| import sphinx_rtd_theme | ||
| except ModuleNotFoundError: | ||
| except ImportError: | ||
| html_theme = 'default' | ||
@@ -133,3 +132,3 @@ else: | ||
| # of the sidebar. | ||
| html_logo = "images/beeware.png" | ||
| html_logo = "_static/images/beeware.png" | ||
@@ -259,3 +258,3 @@ # The name of an image file (within the static path) to use as favicon of the | ||
| ('index', 'beeware', u'BeeWare Documentation', | ||
| u'Russell Keith-Magee', 'BeeWare', 'A Python native, OS native GUI toolkit.', | ||
| u'Russell Keith-Magee', 'BeeWare', 'Write Python. Run anywhere.', | ||
| 'Miscellaneous'), | ||
@@ -262,0 +261,0 @@ ] |
+1
-1
@@ -17,3 +17,3 @@ ======= | ||
| Java libraries from within Python code; | ||
| * Pre-complied builds of Python that can be used on platforms where official | ||
| * Pre-compiled builds of Python that can be used on platforms where official | ||
| Python installers aren't available. | ||
@@ -20,0 +20,0 @@ |
+22
-171
| @ECHO OFF | ||
| pushd %~dp0 | ||
| REM Command file for Sphinx documentation | ||
@@ -8,184 +10,33 @@ | ||
| ) | ||
| set SOURCEDIR=. | ||
| set BUILDDIR=_build | ||
| set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . | ||
| set I18NSPHINXOPTS=%SPHINXOPTS% . | ||
| if NOT "%PAPER%" == "" ( | ||
| set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% | ||
| set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% | ||
| ) | ||
| if "%1" == "" goto help | ||
| if "%1" == "livehtml" goto livehtml | ||
| if "%1" == "help" ( | ||
| :help | ||
| echo.Please use `make ^<target^>` where ^<target^> is one of | ||
| echo. html to make standalone HTML files | ||
| echo. dirhtml to make HTML files named index.html in directories | ||
| echo. singlehtml to make a single large HTML file | ||
| echo. pickle to make pickle files | ||
| echo. json to make JSON files | ||
| echo. htmlhelp to make HTML files and a HTML help project | ||
| echo. qthelp to make HTML files and a qthelp project | ||
| echo. devhelp to make HTML files and a Devhelp project | ||
| echo. epub to make an epub | ||
| echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter | ||
| echo. text to make text files | ||
| echo. man to make manual pages | ||
| echo. texinfo to make Texinfo files | ||
| echo. gettext to make PO message catalogs | ||
| echo. changes to make an overview over all changed/added/deprecated items | ||
| echo. linkcheck to check all external links for integrity | ||
| echo. doctest to run all doctests embedded in the documentation if enabled | ||
| goto end | ||
| ) | ||
| if "%1" == "clean" ( | ||
| for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i | ||
| del /q /s %BUILDDIR%\* | ||
| goto end | ||
| ) | ||
| if "%1" == "html" ( | ||
| %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html | ||
| if errorlevel 1 exit /b 1 | ||
| %SPHINXBUILD% >NUL 2>NUL | ||
| if errorlevel 9009 ( | ||
| echo. | ||
| echo.Build finished. The HTML pages are in %BUILDDIR%/html. | ||
| goto end | ||
| ) | ||
| if "%1" == "dirhtml" ( | ||
| %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml | ||
| if errorlevel 1 exit /b 1 | ||
| echo. | ||
| echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. | ||
| goto end | ||
| ) | ||
| if "%1" == "singlehtml" ( | ||
| %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml | ||
| if errorlevel 1 exit /b 1 | ||
| echo. | ||
| echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. | ||
| goto end | ||
| ) | ||
| if "%1" == "pickle" ( | ||
| %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle | ||
| if errorlevel 1 exit /b 1 | ||
| echo. | ||
| echo.The 'sphinx-build' command was not found. Make sure you have Sphinx | ||
| echo.installed, then set the SPHINXBUILD environment variable to point | ||
| echo.Build finished; now you can process the pickle files. | ||
| goto end | ||
| ) | ||
| if "%1" == "json" ( | ||
| %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json | ||
| if errorlevel 1 exit /b 1 | ||
| echo.may add the Sphinx directory to PATH. | ||
| echo. | ||
| echo.Build finished; now you can process the JSON files. | ||
| goto end | ||
| echo.If you don't have Sphinx installed, grab it from | ||
| echo.http://sphinx-doc.org/ | ||
| exit /b 1 | ||
| ) | ||
| if "%1" == "htmlhelp" ( | ||
| %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp | ||
| if errorlevel 1 exit /b 1 | ||
| echo. | ||
| echo.Build finished; now you can run HTML Help Workshop with the ^ | ||
| .hhp project file in %BUILDDIR%/htmlhelp. | ||
| goto end | ||
| ) | ||
| %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% | ||
| goto end | ||
| if "%1" == "qthelp" ( | ||
| %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp | ||
| if errorlevel 1 exit /b 1 | ||
| echo. | ||
| echo.Build finished; now you can run "qcollectiongenerator" with the ^ | ||
| .qhcp project file in %BUILDDIR%/qthelp, like this: | ||
| echo.^> qcollectiongenerator %BUILDDIR%\qthelp\Trebuchet.qhcp | ||
| echo.To view the help file: | ||
| echo.^> assistant -collectionFile %BUILDDIR%\qthelp\Trebuchet.ghc | ||
| goto end | ||
| ) | ||
| :help | ||
| %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% | ||
| goto end | ||
| if "%1" == "devhelp" ( | ||
| %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp | ||
| if errorlevel 1 exit /b 1 | ||
| echo. | ||
| echo.Build finished. | ||
| goto end | ||
| ) | ||
| :livehtml | ||
| sphinx-autobuild -b html %SPHINXOPTS% %SOURCEDIR% %BUILDDIR%/html | ||
| goto end | ||
| if "%1" == "epub" ( | ||
| %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub | ||
| if errorlevel 1 exit /b 1 | ||
| echo. | ||
| echo.Build finished. The epub file is in %BUILDDIR%/epub. | ||
| goto end | ||
| ) | ||
| if "%1" == "latex" ( | ||
| %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex | ||
| if errorlevel 1 exit /b 1 | ||
| echo. | ||
| echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. | ||
| goto end | ||
| ) | ||
| if "%1" == "text" ( | ||
| %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text | ||
| if errorlevel 1 exit /b 1 | ||
| echo. | ||
| echo.Build finished. The text files are in %BUILDDIR%/text. | ||
| goto end | ||
| ) | ||
| if "%1" == "man" ( | ||
| %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man | ||
| if errorlevel 1 exit /b 1 | ||
| echo. | ||
| echo.Build finished. The manual pages are in %BUILDDIR%/man. | ||
| goto end | ||
| ) | ||
| if "%1" == "texinfo" ( | ||
| %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo | ||
| if errorlevel 1 exit /b 1 | ||
| echo. | ||
| echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. | ||
| goto end | ||
| ) | ||
| if "%1" == "gettext" ( | ||
| %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale | ||
| if errorlevel 1 exit /b 1 | ||
| echo. | ||
| echo.Build finished. The message catalogs are in %BUILDDIR%/locale. | ||
| goto end | ||
| ) | ||
| if "%1" == "changes" ( | ||
| %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes | ||
| if errorlevel 1 exit /b 1 | ||
| echo. | ||
| echo.The overview file is in %BUILDDIR%/changes. | ||
| goto end | ||
| ) | ||
| if "%1" == "linkcheck" ( | ||
| %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck | ||
| if errorlevel 1 exit /b 1 | ||
| echo. | ||
| echo.Link check complete; look for any errors in the above output ^ | ||
| or in %BUILDDIR%/linkcheck/output.txt. | ||
| goto end | ||
| ) | ||
| if "%1" == "doctest" ( | ||
| %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest | ||
| if errorlevel 1 exit /b 1 | ||
| echo. | ||
| echo.Testing of doctests in the sources finished, look at the ^ | ||
| results in %BUILDDIR%/doctest/output.txt. | ||
| goto end | ||
| ) | ||
| :end | ||
| :end | ||
| popd |
+15
-173
@@ -1,181 +0,23 @@ | ||
| # Makefile for Sphinx documentation | ||
| # Minimal makefile for Sphinx documentation | ||
| # | ||
| # You can set these variables from the command line. | ||
| SPHINXOPTS = | ||
| SPHINXBUILD = sphinx-build | ||
| PAPER = | ||
| # You can set these variables from the command line, and also | ||
| # from the environment for the first two. | ||
| SPHINXOPTS ?= | ||
| SPHINXBUILD ?= sphinx-build | ||
| SOURCEDIR = . | ||
| BUILDDIR = _build | ||
| SOURCEDIR = . | ||
| # Put it first so that "make" without argument is like "make help". | ||
| # Internal variables. | ||
| PAPEROPT_a4 = -D latex_paper_size=a4 | ||
| PAPEROPT_letter = -D latex_paper_size=letter | ||
| ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . | ||
| VENV = ../env/bin/activate | ||
| PORT = 8001 | ||
| # the i18n builder cannot share the environment and doctrees with the others | ||
| I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . | ||
| .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext | ||
| help: | ||
| @echo "Please use \`make <target>' where <target> is one of" | ||
| @echo " instal to create a virtualenv called 'env' in the docs directory" | ||
| @echo " html to make standalone HTML files" | ||
| @echo " dirhtml to make HTML files named index.html in directories" | ||
| @echo " singlehtml to make a single large HTML file" | ||
| @echo " pickle to make pickle files" | ||
| @echo " json to make JSON files" | ||
| @echo " htmlhelp to make HTML files and a HTML help project" | ||
| @echo " qthelp to make HTML files and a qthelp project" | ||
| @echo " devhelp to make HTML files and a Devhelp project" | ||
| @echo " epub to make an epub" | ||
| @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" | ||
| @echo " latexpdf to make LaTeX files and run them through pdflatex" | ||
| @echo " text to make text files" | ||
| @echo " man to make manual pages" | ||
| @echo " texinfo to make Texinfo files" | ||
| @echo " info to make Texinfo files and run them through makeinfo" | ||
| @echo " gettext to make PO message catalogs" | ||
| @echo " changes to make an overview of all changed/added/deprecated items" | ||
| @echo " linkcheck to check all external links for integrity" | ||
| @echo " doctest to run all doctests embedded in the documentation (if enabled)" | ||
| @echo " run to start a local autoreloading webserver on port 8001" | ||
| @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) | ||
| clean: | ||
| -rm -rf $(BUILDDIR)/* | ||
| .PHONY: help livehtml Makefile | ||
| html: | ||
| $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html | ||
| @echo | ||
| @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." | ||
| livehtml: | ||
| sphinx-autobuild -b html $(SPHINXOPTS) "$(SOURCEDIR)" "$(BUILDDIR)/html" | ||
| dirhtml: | ||
| $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml | ||
| @echo | ||
| @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." | ||
| singlehtml: | ||
| $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml | ||
| @echo | ||
| @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." | ||
| pickle: | ||
| $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle | ||
| @echo | ||
| @echo "Build finished; now you can process the pickle files." | ||
| json: | ||
| $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json | ||
| @echo | ||
| @echo "Build finished; now you can process the JSON files." | ||
| htmlhelp: | ||
| $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp | ||
| @echo | ||
| @echo "Build finished; now you can run HTML Help Workshop with the" \ | ||
| ".hhp project file in $(BUILDDIR)/htmlhelp." | ||
| qthelp: | ||
| $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp | ||
| @echo | ||
| @echo "Build finished; now you can run "qcollectiongenerator" with the" \ | ||
| ".qhcp project file in $(BUILDDIR)/qthelp, like this:" | ||
| @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/toga.qhcp" | ||
| @echo "To view the help file:" | ||
| @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/toga.qhc" | ||
| devhelp: | ||
| $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp | ||
| @echo | ||
| @echo "Build finished." | ||
| @echo "To view the help file:" | ||
| @echo "# mkdir -p $$HOME/.local/share/devhelp/toga" | ||
| @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/toga" | ||
| @echo "# devhelp" | ||
| epub: | ||
| $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub | ||
| @echo | ||
| @echo "Build finished. The epub file is in $(BUILDDIR)/epub." | ||
| latex: | ||
| $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex | ||
| @echo | ||
| @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." | ||
| @echo "Run \`make' in that directory to run these through (pdf)latex" \ | ||
| "(use \`make latexpdf' here to do that automatically)." | ||
| latexpdf: | ||
| $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex | ||
| @echo "Running LaTeX files through pdflatex..." | ||
| $(MAKE) -C $(BUILDDIR)/latex all-pdf | ||
| @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." | ||
| text: | ||
| $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text | ||
| @echo | ||
| @echo "Build finished. The text files are in $(BUILDDIR)/text." | ||
| man: | ||
| $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man | ||
| @echo | ||
| @echo "Build finished. The manual pages are in $(BUILDDIR)/man." | ||
| texinfo: | ||
| $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo | ||
| @echo | ||
| @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." | ||
| @echo "Run \`make' in that directory to run these through makeinfo" \ | ||
| "(use \`make info' here to do that automatically)." | ||
| info: | ||
| $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo | ||
| @echo "Running Texinfo files through makeinfo..." | ||
| make -C $(BUILDDIR)/texinfo info | ||
| @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." | ||
| gettext: | ||
| $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale | ||
| @echo | ||
| @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." | ||
| changes: | ||
| $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes | ||
| @echo | ||
| @echo "The overview file is in $(BUILDDIR)/changes." | ||
| linkcheck: | ||
| $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck | ||
| @echo | ||
| @echo "Link check complete; look for any errors in the above output " \ | ||
| "or in $(BUILDDIR)/linkcheck/output.txt." | ||
| doctest: | ||
| $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest | ||
| @echo "Testing of doctests in the sources finished, look at the " \ | ||
| "results in $(BUILDDIR)/doctest/output.txt." | ||
| spelling: | ||
| . $(VENV); $(SPHINXBUILD) -b spelling . _build/spelling | ||
| @echo | ||
| @echo "Check finished. Wrong words can be found in " \ | ||
| "build/spelling/output.txt." | ||
| install: | ||
| @echo "... setting up virtualenv" | ||
| virtualenv env | ||
| . $(VENV); pip install -r requirements_docs.txt | ||
| @echo "\n" \ | ||
| "-------------------------------------------------------------------------------------------------- \n" \ | ||
| "* watch, build and serve the documentation: make run \n" \ | ||
| "* check spelling: make spelling \n" \ | ||
| "\n" \ | ||
| "enchant must be installed in order for pyenchant (and therefore spelling checks) to work. See \n" \ | ||
| "http://docs.django-cms.org/en/latest/contributing/documentation.html#install-the-spelling-software \n" \ | ||
| "-------------------------------------------------------------------------------------------------- \n" \ | ||
| run: | ||
| . $(VENV); sphinx-autobuild $(ALLSPHINXOPTS) build/html --host 0.0.0.0 --port $(PORT) | ||
| # Catch-all target: route all unknown targets to Sphinx using the new | ||
| # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). | ||
| %: Makefile | ||
| @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) |
@@ -12,7 +12,28 @@ ============================== | ||
| The first thing we'll need is a working Python interpreter, running Python 3.5 | ||
| or higher. If you're on macOS or Windows, you can get the official installer | ||
| from `the Python website <https://www.python.org/downloads>`_. If you're on | ||
| Linux, you'll install Python using the system package manager (``apt`` on | ||
| Debian/Ubuntu/Mint; ``dnf`` on Fedora, or ``pacman`` on Arch). | ||
| or higher. | ||
| .. tabs:: | ||
| .. group-tab:: macOS | ||
| If you're on macOS, you can get the official installer from | ||
| `the Python website <https://www.python.org/downloads>`_. You can use any | ||
| stable version of Python from 3.5 onward (although we'd advice avoiding | ||
| alphas, betas and release candidates unless you *really* know what you're | ||
| doing). | ||
| .. group-tab:: Linux | ||
| If you're on Linux, you'll install Python using the system package manager | ||
| (``apt`` on Debian/Ubuntu/Mint; ``dnf`` on Fedora, or ``pacman`` on Arch). | ||
| .. group-tab:: Windows | ||
| If you're on Windows, you can get the official installer from | ||
| `the Python website <https://www.python.org/downloads>`_. You can use any | ||
| stable version of Python 3.5, 3.6 or 3.7. We would advise *against* using | ||
| Python 3.8 at this time, as some libraries needed for this tutorial aren't | ||
| yet available for Python 3.8. We also advise avoiding alphas, betas and | ||
| release candidates unless you *really* know what you're doing. | ||
| .. admonition:: Alternative Python distributions | ||
@@ -34,2 +55,4 @@ | ||
| .. _install-dependencies: | ||
| Install dependencies | ||
@@ -44,6 +67,11 @@ ==================== | ||
| Building BeeWare apps on macOS requires Xcode. Xcode is available for free | ||
| from `the macOS App Store | ||
| <https://apps.apple.com/au/app/xcode/id497799835?mt=12>`__. | ||
| Building BeeWare apps on macOS requires: | ||
| * **Git**, a version control system. You can download Git from from | ||
| `git-scm.org <https://git-scm.com/download/>`__. | ||
| * **Xcode**, Apple's IDE tooling. Xcode is available for free | ||
| from `the macOS App Store | ||
| <https://apps.apple.com/au/app/xcode/id497799835?mt=12>`__. | ||
| .. group-tab:: Linux | ||
@@ -59,3 +87,3 @@ | ||
| $ sudo apt-get update | ||
| $ sudo apt-get install python3-dev python3-venv libgirepository1.0-dev libcairo2-dev libpango1.0-dev libwebkitgtk-3.0-0 gir1.2-webkit-3.0 | ||
| $ sudo apt-get install git python3-dev python3-venv libgirepository1.0-dev libcairo2-dev libpango1.0-dev libwebkitgtk-3.0-0 gir1.2-webkit-3.0 | ||
@@ -67,3 +95,3 @@ **Ubuntu 18.04, Debian 10** | ||
| $ sudo apt-get update | ||
| $ sudo apt-get install python3-dev python3-venv libgirepository1.0-dev libcairo2-dev libpango1.0-dev libwebkit2gtk-4.0-37 gir1.2-webkit2-4.0 | ||
| $ sudo apt-get install git python3-dev python3-venv libgirepository1.0-dev libcairo2-dev libpango1.0-dev libwebkit2gtk-4.0-37 gir1.2-webkit2-4.0 | ||
@@ -74,11 +102,16 @@ **Fedora** | ||
| # Fedora | ||
| $ sudo dnf install pkg-config python3-devel gobject-introspection-devel cairo-devel cairo-gobject-devel pango-devel webkitgtk3 | ||
| $ sudo dnf install git pkg-config python3-devel gobject-introspection-devel cairo-devel cairo-gobject-devel pango-devel webkitgtk3 | ||
| .. group-tab:: Windows | ||
| Building Windows installers requires the `WiX Toolset | ||
| <https://wixtoolset.org/releases/>`__. | ||
| Building BeeWare apps on Windows requires: | ||
| * **Git**, a version control system. You can download Git from from | ||
| `git-scm.org <https://git-scm.com/download/>`__. | ||
| * **WiX Toolset**, a set of utilities for building Windows installers. An | ||
| installer can be obtained from `the WiX Toolset website | ||
| <https://wixtoolset.org/releases/>`__. | ||
| Set up a virtual environment | ||
@@ -91,3 +124,3 @@ ============================ | ||
| (and any other Python projects on our computer) won't be affected. If we make | ||
| a complete mess of our virutal environment, we'll be able to simply delete it | ||
| a complete mess of our virtual environment, we'll be able to simply delete it | ||
| and start again, without affecting any other Python project on our computer, | ||
@@ -94,0 +127,0 @@ and without the need to re-install Python. |
@@ -10,7 +10,7 @@ =========================== | ||
| First, we need to install the beeware tools and libraries. BeeWare provides a | ||
| convenient shortcut for doing this: a ``beeware`` meta-package on PyPI that | ||
| includes all the pieces you'll need to run this tutorial. Make sure you're in | ||
| the ``beeware-tutorial`` you created in :doc:`Tutorial 0 <tutorial-0>`, with | ||
| the ``beeware-venv`` virtual environment activated, and run: | ||
| First, we need to install **Briefcase**. Briefcase is a BeeWare tool that can | ||
| be used to package your application for distribution to end users - but it can | ||
| also be used to bootstrap a new project. Make sure you're in the | ||
| ``beeware-tutorial`` directory you created in :doc:`Tutorial 0 <tutorial-0>`, | ||
| with the ``beeware-venv`` virtual environment activated, and run: | ||
@@ -23,3 +23,3 @@ .. tabs:: | ||
| (beeware-venv) $ pip install --pre beeware | ||
| (beeware-venv) $ python -m pip install briefcase | ||
@@ -30,4 +30,11 @@ .. group-tab:: Linux | ||
| (beeware-venv) $ pip install --pre beeware | ||
| (beeware-venv) $ python -m pip install briefcase | ||
| .. admonition:: Possible errors during installation | ||
| If you see errors during installation, it's almost certainly because | ||
| some of the system requirements haven't been installed. Make sure you | ||
| have :ref:`installed all the platform pre-requisistes | ||
| <install-dependencies>`. | ||
| .. group-tab:: Windows | ||
@@ -37,7 +44,61 @@ | ||
| (beeware-venv)C:\...>pip install --pre beeware | ||
| (beeware-venv)C:\...>python -m pip install briefcase | ||
| .. admonition:: Possible errors during installation | ||
| ℹ️ : ``--pre`` is a flag to tell ``pip`` to install pre-release or development versions. This ensures you are installing the most recent development version of Beeware. | ||
| If you're using a more recent version of Python (3.8+), installing the | ||
| ``beeware`` package may raise an error. This will usually manifest as: | ||
| .. code-block:: doscon | ||
| Traceback (most recent call last): | ||
| File "<string>", line 1, in <module> | ||
| File "C:\...\Local\Temp\pip-install-ytuu_37_\pythonnet\setup.py", line 18, in <module> | ||
| from wheel import bdist_wheel | ||
| ModuleNotFoundError: No module named 'wheel' | ||
| ---------------------------------------- | ||
| ERROR: Command errored out with exit status 1: python setup.py egg_info Check the logs for full command output. | ||
| Depending on the specifics of your environment, it might also manifest | ||
| as a report that includes the following: | ||
| .. code-block:: doscon | ||
| Building wheel for pythonnet (setup.py) ... error | ||
| ERROR: Command errored out with exit status 1: | ||
| ... | ||
| File "c:\...\Local\Programs\Python\Python38\lib\subprocess.py", line 364, in check_call | ||
| raise CalledProcessError(retcode, cmd) | ||
| subprocess.CalledProcessError: Command '['...\\python.exe', 'tools\\geninterop\\geninterop.py', 'src\\runtime\\interop38.cs']' returned non-zero exit status 1. | ||
| ---------------------------------------- | ||
| ERROR: Failed building wheel for pythonnet | ||
| Running setup.py clean for pythonnet | ||
| Failed to build pythonnet | ||
| This is caused because the ``beeware`` package has dependencies, and on | ||
| Windows, one of those dependencies is `Python for .NET | ||
| <http://pythonnet.github.io/>`__. Python for .NET isn't a pure Python | ||
| package - it contains C# modules that need to be compiled. The Python | ||
| for .NET team publishes pre-compiled versions of these modules, but | ||
| they sometimes lag behind in support of more recent versions of Python. | ||
| If you get this error, you have three options: | ||
| 1. Use an older version of Python. Check the `pythonnet entry on | ||
| PyPI <https://pypi.org/project/pythonnet/>`__ to see the versions | ||
| of Python currently supported by Python for .NET. | ||
| 2. Configure your environment to support compiling Python for .NET. | ||
| This is a moderately complex process, and will require you to have | ||
| Visual Studio. See `the Python for .NET wiki | ||
| <https://github.com/pythonnet/pythonnet/wiki/Installation>`__ for | ||
| details. | ||
| 3. Install an unofficial compiled wheel. The Python for .NET team | ||
| suggests `this collection of wheels | ||
| <https://www.lfd.uci.edu/~gohlke/pythonlibs/#pythonnet>`__ as a | ||
| possible source. The `.whl` file can be installed with | ||
| ``python -m pip install somefile.whl``; you should then be able to | ||
| re-run ``python -m pip install --pre beeware``. | ||
| One of the BeeWare tools is **Briefcase**. Briefcase can be used to package | ||
@@ -50,5 +111,5 @@ your application for distribution to end users - but it can also be used to | ||
| Let's start our first BeeWare project! Using the Briefcase ``new`` command, | ||
| we're going to create an application called **Hello World**. Run the following | ||
| from your command prompt: | ||
| Let's start our first BeeWare project! We're going to use the Briefcase | ||
| ``new`` command to create an application called **Hello World**. Run the | ||
| following from your command prompt: | ||
@@ -55,0 +116,0 @@ .. tabs:: |
@@ -155,7 +155,7 @@ ================================== | ||
| Toga's builtin layout system is called "Pack". It behaves a lot like CSS. You | ||
| define objects in a heirarchy - in HTML, the objects are ``<div>``, ``<span>``, | ||
| define objects in a hierarchy - in HTML, the objects are ``<div>``, ``<span>``, | ||
| and other DOM elements; in Toga, they're widgets and boxes. You can then assign | ||
| styles to the individual elements. In this case, we're indicating that this is | ||
| a ``COLUMN`` box - that is, it is a box that will consume all the available | ||
| width, and will expand it's height as content is added, but it will try to be | ||
| width, and will expand its height as content is added, but it will try to be | ||
| as short as possible. | ||
@@ -172,5 +172,5 @@ | ||
| Here, we define a Label and a TextInput. Both widgets have styles associated | ||
| with them; the label will have 5px of padding on it's left and right, and no | ||
| with them; the label will have 5px of padding on its left and right, and no | ||
| padding on the top and bottom. The TextInput is marked as being flexible - that | ||
| is, it will absorb all available space in it's layout axis. | ||
| is, it will absorb all available space in its layout axis. | ||
@@ -188,3 +188,3 @@ The TextInput is assigned as an instance variable of class. This gives us | ||
| ``ROW`` box. That means content will be added horizontally, and it will try | ||
| to make it's width as narrow as possible. The box also has some padding - 5px | ||
| to make its width as narrow as possible. The box also has some padding - 5px | ||
| on all sides. | ||
@@ -191,0 +191,0 @@ |
@@ -45,5 +45,5 @@ ======================================= | ||
| Once this step completes, the ``macOS`` folder will contain a ``Hello | ||
| World`` folder. That folder fill contain another folder named ``Hello | ||
| World`` folder. That folder will contain another folder named ``Hello | ||
| World.app``. This ``.app`` folder is a self contained macOS executable. If | ||
| you open the Finder, you can double click on the icon for thi folder to | ||
| you open the Finder, you can double click on the icon for this folder to | ||
| start your application. If you send ``Hello World.app`` to a friend, they | ||
@@ -89,4 +89,4 @@ will be able to do the same - double click on the app, and see your app | ||
| $ apt-get update | ||
| $ apt-get install python3-dev libgirepository1.0-dev libcairo2-dev libpango1.0-dev libwebkitgtk-3.0-0 gir1.2-webkit-3.0 | ||
| $ pip install beeware | ||
| $ apt-get install git python3-dev python3-pip libgirepository1.0-dev libcairo2-dev libpango1.0-dev libwebkitgtk-3.0-0 gir1.2-webkit-3.0 | ||
| $ python3 -m pip install --pre beeware | ||
@@ -185,3 +185,3 @@ There is no need to use a virtual environment inside the Docker | ||
| 4. It **Installed your application code**. Your application will have it's own | ||
| 4. It **Installed your application code**. Your application will have its own | ||
| code and resources (e.g., images that are needed at runtime); these files | ||
@@ -203,3 +203,3 @@ are copied into the installer. | ||
| You can now compile your your application. This step performs any binary | ||
| You can now compile your application. This step performs any binary | ||
| compilation that is necessary for your application to be executable on your | ||
@@ -267,3 +267,3 @@ target platform. | ||
| [helloworld] Starting app... | ||
| (beeware-venv) $ | ||
@@ -279,3 +279,3 @@ | ||
| (beeware-venv) $ | ||
| (beeware-venv) $ | ||
@@ -293,3 +293,3 @@ .. group-tab:: Windows | ||
| This will start your run your native application, using the output of the | ||
| `build` command. | ||
| `build` command. | ||
@@ -303,3 +303,3 @@ You may notice some small differences in the way your application looks when | ||
| application appears. The console output we saw earlier also won't work anymore, | ||
| since we are running a standalone app that has no console to output to. | ||
| since we are running a standalone app that has no console to output to. | ||
@@ -328,3 +328,3 @@ Building your installer | ||
| The ``macOS`` folder will contain a file named ``Hello World-0.0.1.dmg``. | ||
| If you locate this file in the Finder, and double click on it's icon, | ||
| If you locate this file in the Finder, and double click on its icon, | ||
| you'll mount the DMG, giving you a copy of the Hello World app, and a | ||
@@ -331,0 +331,0 @@ link to your Applications folder for easy installation. Drag the app file |
@@ -86,3 +86,3 @@ ====================================== | ||
| to re-compiled app, ``briefcase run`` to run the updated app, and ``briefcase | ||
| publish`` to repackage the application for distribution. | ||
| package`` to repackage the application for distribution. | ||
@@ -89,0 +89,0 @@ Updating dependencies and icons |
@@ -33,3 +33,3 @@ ================================== | ||
| You can then use Briefcase to compile the application compile your app, using | ||
| You can then use Briefcase to compile your app using | ||
| the ``build`` command. You'll be prompted to select a device to compile for; if | ||
@@ -36,0 +36,0 @@ you've got simulators for multiple iOS versions installed, you may also be |
+5
-5
| Metadata-Version: 2.1 | ||
| Name: beeware | ||
| Version: 0.3.0.dev3 | ||
| Version: 0.3.0 | ||
| Summary: A metapackage to install the full BeeWare suite of tools. | ||
@@ -38,4 +38,4 @@ Home-page: http://beeware.org/ | ||
| .. image:: https://github.com/beeware/beefore/workflows/Build%20status/badge.svg | ||
| :target: https://github.com/beeware/beefore/actions | ||
| .. image:: https://github.com/beeware/beeware/workflows/CI/badge.svg?branch=master | ||
| :target: https://github.com/beeware/beeware/actions | ||
| :alt: Build Status | ||
@@ -51,3 +51,3 @@ | ||
| For a introduction to the full BeeWare suite, we recommend running the | ||
| For an introduction to the full BeeWare suite, we recommend running the | ||
| `BeeWare Tutorial`_. | ||
@@ -95,3 +95,3 @@ | ||
| Classifier: Topic :: Utilities | ||
| Requires-Python: >= 3.5 | ||
| Requires-Python: >=3.5 | ||
| Description-Content-Type: text/x-rst; charset=UTF-8 |
+3
-3
@@ -24,4 +24,4 @@ .. image:: https://beeware.org/static/images/brutus-270.png | ||
| .. image:: https://github.com/beeware/beefore/workflows/Build%20status/badge.svg | ||
| :target: https://github.com/beeware/beefore/actions | ||
| .. image:: https://github.com/beeware/beeware/workflows/CI/badge.svg?branch=master | ||
| :target: https://github.com/beeware/beeware/actions | ||
| :alt: Build Status | ||
@@ -37,3 +37,3 @@ | ||
| For a introduction to the full BeeWare suite, we recommend running the | ||
| For an introduction to the full BeeWare suite, we recommend running the | ||
| `BeeWare Tutorial`_. | ||
@@ -40,0 +40,0 @@ |
+2
-3
| [metadata] | ||
| name = beeware | ||
| version = 0.3.0.dev3 | ||
| version = 0.3.0 | ||
| url = http://beeware.org/ | ||
@@ -38,4 +38,3 @@ project_urls = | ||
| install_requires = | ||
| briefcase >= 0.3.0.dev3 | ||
| toga >= 0.3.0.dev17 | ||
| briefcase >= 0.3.0 | ||
@@ -42,0 +41,0 @@ [bdist_wheel] |
Sorry, the diff of this file is not supported yet
| sphinx_tabs | ||
| sphinx | ||
| sphinxcontrib-spelling | ||
| pyenchant | ||
| sphinx-autobuild | ||
| sphinx_rtd_theme | ||
| sphinx_tabs |
Alert delta unavailable
Currently unable to show alert delta for PyPI packages.
Worsened metrics
- Total package byte prevSize
905819
-0.65%- Lines of code
216
-0.92%