Skip to content

Commit

Permalink
Merge pull request #19 from freakboy3742/v0.3
Browse files Browse the repository at this point in the history
Modify BeeWare to support Briefcase v0.3
  • Loading branch information
freakboy3742 committed Dec 21, 2019
2 parents 4213413 + d160038 commit cec6b32
Show file tree
Hide file tree
Showing 34 changed files with 1,062 additions and 429 deletions.
29 changes: 29 additions & 0 deletions .github/workflows/build_status.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Build status
on:
push:
branches:
- master

jobs:
docs:
name: Docs build
runs-on: ubuntu-latest
strategy:
max-parallel: 4
matrix:
task: ['pycodestyle']
steps:
- uses: actions/checkout@v1
- name: Set up Python 3.8
uses: actions/setup-python@v1
with:
python-version: 3.8
- name: Install dependencies
run: |
pip install --upgrade pip setuptools
pip install -r docs/requirements.txt
- name: Run Beefore checks
env:
GITHUB_ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
cd docs && make html
30 changes: 20 additions & 10 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -1,17 +1,27 @@
name: CI

on: [push]
on: [pull_request]

jobs:
build:

docs:
name: Docs build
runs-on: ubuntu-latest

strategy:
max-parallel: 4
matrix:
task: ['pycodestyle']
steps:
- uses: actions/checkout@v1
- name: Run a one-line script
run: echo Hello, world!
- name: Run a multi-line script
- name: Set up Python 3.8
uses: actions/setup-python@v1
with:
python-version: 3.8
- name: Install dependencies
run: |
echo Add other actions to build,
echo test, and deploy your project.
pip install --upgrade pip setuptools
pip install -r docs/requirements.txt
- name: Run Beefore checks
env:
GITHUB_ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
cd docs && make html
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -97,3 +97,4 @@ local/
# runtime data
runtime/

.vscode/
87 changes: 28 additions & 59 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,72 +1,40 @@
.. image:: https://beeware.org/static/images/brutus-270.png
:width: 72px
:target: https://pybee.org
:width: 72px
:target: https://beeware.org

BeeWare
=======

.. image:: https://img.shields.io/pypi/pyversions/beeware.svg
:target: https://pypi.python.org/pypi/beeware
:target: https://pypi.python.org/pypi/beeware
:alt: Python Versions

.. image:: https://img.shields.io/pypi/v/beeware.svg
:target: https://pypi.python.org/pypi/beeware
:target: https://pypi.python.org/pypi/beeware
:alt: PyPI Version

.. image:: https://img.shields.io/pypi/status/beeware.svg
:target: https://pypi.python.org/pypi/beeware
:target: https://pypi.python.org/pypi/beeware
:alt: Maturity

.. image:: https://img.shields.io/pypi/l/beeware.svg
:target: https://github.com/pybee/beeware/blob/master/LICENSE
:target: https://github.com/beeware/beeware/blob/master/LICENSE
:alt: BSD License

.. image:: https://badges.gitter.im/pybee/general.svg
:target: https://gitter.im/pybee/general
.. image:: https://github.com/beeware/beefore/workflows/Build%20status/badge.svg
:target: https://github.com/beeware/beefore/actions
:alt: Build Status

.. image:: https://badges.gitter.im/beeware/general.svg
:target: https://gitter.im/beeware/general
:alt: Chat on Gitter

BeeWare is a collection of tools and libraries to aid native application
development in Python.

This package provides a convenient user interface to drive those tools.
BeeWare is a collection of tools and libraries for building and distributing
native applications in Python.

Usage
-----

To install BeeWare, create a new virtual environment::

$ mkdir beeware
$ cd beeware
beeware $ python -m venv venv
beeware $ ./venv/bin/activate

(or, if you're on Windows)::

beeware $ venv\Scripts\activate.bat

Then, install BeeWare in that virtual environment::

(venv) $ pip install beeware

To start a new project, run::

(venv) $ beeware new

This will prompt you for details of your new project, such as the name,
description, and license.

Once you've added your application code, run::

(venv) $ beeware build ios

from the directory that beeware created to build your application. To run
your application::

(venv) $ beeware run ios

You can also target `android`, `macos`, `windows`, `linux` or `django`.

Depending on your choice of target, this will either (as appropriate):

* Run the app in the simulator for iOS or Android;
* Start a desktop app on Windows, macOS or Linux; or
* Start a webserver on port 8000 for Django
For a introduction to the full BeeWare suite, we recommend running the
`BeeWare Tutorial`_.

Community
---------
Expand All @@ -75,7 +43,7 @@ You can talk to the BeeWare community through:

* `@pybeeware on Twitter`_

* The `pybee/general`_ channel on Gitter.
* The `beeware/general`_ channel on Gitter.

We foster a welcoming and respectful community as described in our
`BeeWare Community Code of Conduct`_.
Expand All @@ -86,10 +54,11 @@ Contributing
If you experience problems with BeeWare, `log them on GitHub`_. If you
want to contribute code, please `fork the code`_ and `submit a pull request`_.

.. _BeeWare suite: http://pybee.org
.. _BeeWare suite: https://beeware.org
.. _BeeWare Tutorial: https://beeware.readthedocs.io/en/latest/tutorial/
.. _@pybeeware on Twitter: https://twitter.com/pybeeware
.. _pybee/general: https://gitter.im/pybee/general
.. _BeeWare Community Code of Conduct: http://pybee.org/community/behavior/
.. _log them on Github: https://github.com/pybee/beeware/issues
.. _fork the code: https://github.com/pybee/beeware
.. _submit a pull request: https://github.com/pybee/beeware/pulls
.. _beeware/general: https://gitter.im/beeware/general
.. _BeeWare Community Code of Conduct: http://beeware.org/community/behavior/
.. _log them on Github: https://github.com/beeware/beeware/issues
.. _fork the code: https://github.com/beeware/beeware
.. _submit a pull request: https://github.com/beeware/beeware/pulls
67 changes: 0 additions & 67 deletions beeware.py

This file was deleted.

5 changes: 0 additions & 5 deletions docs/background/faq.rst

This file was deleted.

13 changes: 0 additions & 13 deletions docs/background/index.rst

This file was deleted.

13 changes: 0 additions & 13 deletions docs/background/releases.rst

This file was deleted.

5 changes: 0 additions & 5 deletions docs/background/roadmap.rst

This file was deleted.

4 changes: 0 additions & 4 deletions docs/background/success.rst

This file was deleted.

4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@
#
# The full version, including alpha/beta/rc tags.
import io, re
with io.open('../beeware.py', encoding='utf8') as version_file:
version_match = re.search(r"^__version__ = ['\"]([^'\"]*)['\"]", version_file.read(), re.M)
with io.open('../setup.cfg', encoding='utf8') as version_file:
version_match = re.search(r"^version = (.*)$", version_file.read(), re.M)
if version_match:
release = version_match.group(1)
else:
Expand Down
12 changes: 0 additions & 12 deletions docs/how-to/contribute.rst

This file was deleted.

25 changes: 0 additions & 25 deletions docs/how-to/get-started.rst

This file was deleted.

12 changes: 0 additions & 12 deletions docs/how-to/index.rst

This file was deleted.

0 comments on commit cec6b32

Please sign in to comment.