beeware/beeware.github.io

🐍🐝

beeware.github.io

This is the homepage for the BeeWare project.

It is a Lektor-based site.

If you want to contribute a modification, you can fork this repository and submit a pull request. However, do not fork the master branch - fork the lektor branch and make changes there instead.

If you want to test out a change before you submit it, create a virtual environment, and install Lektor:

$ python3 -m venv venv
$ source venv/bin/activate
(venv) $ python -m pip install lektor

Then from the root directory of the checkout, run:

(venv) $ lektor server

This will start a webserver that will autoreload whenever you make a change to site content.

Community

You can talk to the community through:

• @[email protected] on Mastodon
• BeeWare Discord server: Discord
• Tickets on the beeware.github.io issue tracker

Contributing

If you find problems with this website, log them on GitHub. If you want to contribute, please fork the code and submit a pull request.

Before submitting a pull request, please make sure your forked branch is up to date with the original branch. To do this:

• set your upstream remote:

  $ git remote add upstream https://github.com/beeware/beeware.github.io.git

• make sure you have the latest changes from upstream:

  $ git fetch upstream

• rebase your lektor branch to upstream before pushing to git and submitting a pull request:

  $ git rebase upstream/lektor

Translating

Want to make BeeWare more accessible to non-English-speakers? Help translate the site! Steps are as follows:

1. Add language specification to BeeWare.lektorproject.

   Fill out the name of the language, its url prefix, and the locale. Make sure you use the correct ISO 639-1 locale code - for many countries, it's not the same as the national TLD. For example, the ISO 639-1 Danish locale is 'da', but Denmark uses the '.dk' TLD.

2. Add an entry for your language to the Atom configuration.
3. Add your first translation, by translating the names for the menus at the top of each page. Edit the menus translation file, adding a block for your language.
4. Start adding translations for content pages on the site. Translated files are at the same directory level as the primary English files, but have a language suffix. For example, Arabic's locale is 'ar', so you would add contents+ar.lr wherever the original file name is contents.lr

A great place to start translating is the contributing section.

beeware.github.io's Issues

Broken tag on homepage "Projects" navigation

The homepage projects-menu looks like there's a broken Lektor tag:

<lektor_rst.rst object="" at<br="">0x7f4fe342df10&gt;
    </lektor_rst.rst>

Don't quite know what's happening here as I'm not familiar with the tool but output looks like this:

Code of conduct is 404 on "about" page

On
https://pybee.org/project/about/
Almost at the bottom, the link to
https://pybee.org/project/about/community/code-of-conduct/ produces a 404

Mobile Friendly Design

Currently most of the BeeWare webpages look like this, this issue is to change the pages to be mobile device friendly like this. I'd say mobile portrait is a good start.

I'm planning to take on a few of these pages during the PyCon 2018 sprints.

Pipenv should be added to Setting up your environment guide.

Pipenv — the officially recommended Python packaging tool from Python.org, free (as in freedom).
It automatically creates and manages a virtualenv for your projects, as well as adds/removes packages from your Pipfile as you install/uninstall packages.

And it is much easier to setup virtual environment with different python versions with Pipenv.

Add github edit links to every document on the site

Sometimes user are reading the documentation on the website and they find a typo or some small error. Having a link to the specific file in the specific language (to github edit) available is of great help for this!

Thoughts?

Uninstalling old app hangs / takes long time

[...]
Build complete.

Starting app on iPhone 7 Plus iOS 10.2
 * Starting simulator...
Waiting for device to boot...
 * Uninstalling old app version...

Stuck at that point (ran 15 mins already, tried multiple times). Seems to get stuck at roughly 90-95% on the apple loading bar.

Virtualenv: python 3.5, briefcase-0.2.1
MacOS: 10.11.6 (15G1611)
Command: python setup.py ios -s

Any ideas why and what to do?

RTL languages

Arabic for example, is written from right-to-left,

This is wrong, and sometimes it's hard to read for an Arab user, like it will be [email protected] for more information contact.

The correct form should be:

---

I'd like to help you by fixing this issue, is it okay to load a JS file that checks the current URL, if it's Arabic, Farsi or Hebrew, it applies the direction: rtl property to the template, with some exceptions (English content...).

Or is there a better solution?

Global CONTRIBUTING.md

(Putting this issue under the pybee.github.io repo, as it seems like the best place to put global matters)

GitHub does fancy things with a CONTRIBUTING{,.md} file, where it will display a link to it on new issues opened[0]. Example link

The index.html on this repo already points to the Python Community Code of Conduct. This is awesome! But it would be great if this could be linked in all repos. Unfortunately, that requires creating a CONTRIBUTING file per repo (and it may or may not allow a CONTRIBUTING.rst, unfortunately.)

My thought: create a global CONTRIBUTING under this repo. Link out to the CoC, detail all the information about how issues are welcomed. For any other repos, create a CONTRIBUTING stub file, with just a basic link out to the main thing. Something like:

# CONTRIBUTING

PyBee operates under a Code of Conduct. See [CONTRIBUTING to PyBee](https://github.com/pybee/pybee.github.io)

The canonical CONTRIBUTING file should probably also describe how much contributions are welcomed, even more than the current stub does (currently for VOC: "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.")

Pro: one canonical version of CONTRIBUTING linked to all repos. Stub on all repos click through to the canonical version
Pro: linking to a canonical CONTRIBUTING allows easier communication of any changes (e.g. if a different CoC is chosen later)
Con: all repos need a CONTRIBUTING file to appear in the GitHub Issues flash message. Mitigation - create a sufficiently short and sweet mini-CONTRIBUTING file to link to the canonical version.
Con: using the github pages repo to store this uses an existing repo, but I think creating a new repo just for this kind of documentation is overkill

More than happy to discuss this further.

[0] This, and many other awesome tips, from @pjf's FOSS Community talk at OSDC (video)

Debug auto deploy

@freakboy3742 @singingwolfboy

Cleaning up git repository with git stash --all. If you need build artifacts for deployment, set deploy.skip_cleanup: true. See https://docs.travis-ci.com/user/deployment/#Uploading-Files.

Wondering if telling Travis to deploy.skip_cleanup:true would help???

RuntimeError: Failed to install dependency package.

I'm following the instructions as described in the README.rst file
so i created a virtual environment venv and choose python2 as the python interpreter
i activated the virtual environment and install lektor via pip install lektor , but when i run lektor server am getting this error RuntimeError: Failed to install dependency package.

i'm on xubuntu 18.04 machine
using python2 and virtualenv

and this is the full traceback :

Updating packages in /home/m4dc0d3r/.cache/lektor/packages/040fcb00f7af41ad65f95162fc80b155 for project
DEPRECATION: Python 2.7 reached the end of its life on January 1st, 2020. Please upgrade your Python as Python 2.7 is no longer maintained. A future version of pip will drop support for Python 2.7. More details about Python 2 support in pip, can be found at https://pip.pypa.io/en/latest/development/release-process/#python-2-support
ERROR: Could not find a version that satisfies the requirement lektor-atom==0.3 (from versions: 0.1, 0.2)
ERROR: No matching distribution found for lektor-atom==0.3
Traceback (most recent call last):
  File "/home/m4dc0d3r/Desktop/PROJECTS/beeware.github.io/venv/bin/lektor", line 8, in <module>
    sys.exit(main())
  File "/home/m4dc0d3r/Desktop/PROJECTS/beeware.github.io/venv/local/lib/python2.7/site-packages/lektor/cli.py", line 627, in main
    cli.main(args=args, prog_name=name)
  File "/home/m4dc0d3r/Desktop/PROJECTS/beeware.github.io/venv/local/lib/python2.7/site-packages/click/core.py", line 782, in main
    rv = self.invoke(ctx)
  File "/home/m4dc0d3r/Desktop/PROJECTS/beeware.github.io/venv/local/lib/python2.7/site-packages/click/core.py", line 1259, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/home/m4dc0d3r/Desktop/PROJECTS/beeware.github.io/venv/local/lib/python2.7/site-packages/click/core.py", line 1066, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "/home/m4dc0d3r/Desktop/PROJECTS/beeware.github.io/venv/local/lib/python2.7/site-packages/click/core.py", line 610, in invoke
    return callback(*args, **kwargs)
  File "/home/m4dc0d3r/Desktop/PROJECTS/beeware.github.io/venv/local/lib/python2.7/site-packages/click/decorators.py", line 73, in new_func
    return ctx.invoke(f, obj, *args, **kwargs)
  File "/home/m4dc0d3r/Desktop/PROJECTS/beeware.github.io/venv/local/lib/python2.7/site-packages/click/core.py", line 610, in invoke
    return callback(*args, **kwargs)
  File "/home/m4dc0d3r/Desktop/PROJECTS/beeware.github.io/venv/local/lib/python2.7/site-packages/lektor/cli.py", line 380, in server_cmd
    ctx.load_plugins()
  File "/home/m4dc0d3r/Desktop/PROJECTS/beeware.github.io/venv/local/lib/python2.7/site-packages/lektor/cli.py", line 130, in load_plugins
    load_packages(self.get_env(), reinstall=reinstall)
  File "/home/m4dc0d3r/Desktop/PROJECTS/beeware.github.io/venv/local/lib/python2.7/site-packages/lektor/packages.py", line 306, in load_packages
    refresh=reinstall)
  File "/home/m4dc0d3r/Desktop/PROJECTS/beeware.github.io/venv/local/lib/python2.7/site-packages/lektor/packages.py", line 276, in update_cache
    download_and_install_package(package_root, package, version)
  File "/home/m4dc0d3r/Desktop/PROJECTS/beeware.github.io/venv/local/lib/python2.7/site-packages/lektor/packages.py", line 105, in download_and_install_package
    raise RuntimeError('Failed to install dependency package.')
RuntimeError: Failed to install dependency package.

Feed for news?

Thanks for an awesome project so far! I've been eagerly following along. I went to http://pybee.org/news/ and was hoping to follow project news easily, unfortunately there's no RSS/Atom feed.

It looks like there's a lektor plugin that could enable this: https://github.com/ajdavis/lektor-atom

Video of "Python All the Things" isn't loading because of same origin policy

Right now if you google python all the things, one of the first relevant results is this page:

http://pybee.org/community/resources/python-all-the-things/

Unfortunately, the video isn't loading (tested on Chrome and FF), apparently because of Same Origin Policy:

Labelling the GitHub repository tickets

Hi Maintainers!

I am thinking of contributing in different projects of the beeware org. I was seeing the tickets aren't labelled in any GitHub repository. If you can label the tickets, would help folks who would like contributing.

Signal users that a translation is potentially out of date

How to signal to the user? Maybe an exlamation triangle next to the translate link - possibly in red, or something else that will draw attention - with some pop-out text that explains (in native language) that the translation is out of date (maybe even with dates/number of lines changed?). Does that sound appropriate?

Status page for target platforms

Hi I'm interested in using Pybee to make applications. The homepage at pybee.org lists "iOS, Android, Windows, MacOS, Linux, Web, and tvOS" as target platforms.

I'm wondering which of these is currently ready for use in applications. I see from the Gitter chat that

iOS is relatively stable as a platform, but doesn’t have a lot of widgets built yet. Android, unfortunately, is in a badly broken state at the moment.

Assuming other people might be interested in following the project or joining in, would it make sense to have a status page showing the current support status of each of the listed targets? Does this already exist and I missed it? Thanks! :-)

Project images 404s

Hi.

The homepage has a few 404s:

The files exist in the project, e.g. https://github.com/pybee/pybee.github.io/blob/lektor/content/project/projects/libraries/toga/toga.png exists.

Also the URLs work without the -32 suffix, e.g. http://pybee.org/project/projects/libraries/toga/toga.png is fine.

So, either:

1. Remove the -32 suffixes, or
2. Maybe there's a build step to create those images missing

???

Happy to do a PR, certainly for option 1. (Although 2 as well if you can guide me slightly.)

Spanish translation

Hello!, this project is awesome and I would like to contribute in the near future. In the meantime I can start by translating to Spanish. (Also I really like Lektor :-p )

Greetings from Colombia.

Document project interlinking

Things depend on each other, and we don't have a good picture of this interconnectivity documented at the moment.

using/ios-app/ actually makes reference to Android instead of iOS

In the last paragraph it says:

Once you've written your native iOS application, you can use Briefcase to package your Python code as an iOS application bundle. Briefcase takes the distutils setup.py definition for your Python project, and uses that metadata to generate a stub iOS Xcode project, and add your Python code and dependencies so that they will be found when you run your the Android project. The stub project is generated using the Python iOS template.

It should be iOS, right?

Wrongly named list item in language selection dropdown on website

I spotted a bug in the BeeWare site that shows when users try to change the language option - a 'None' option exists in the language list - this should be changed to Danish. See the screenshot below:

Fix URL errors

Error number: 0
Status code or error type: 502
https://2016.pyohio.org/schedule/
---------------------------------
	http://127.0.0.1:5000/ar_AR/news/events/pyohio-2016
	http://127.0.0.1:5000/de_DE/news/events/pyohio-2016
	http://127.0.0.1:5000/es/noticias/eventos/pyohio-2016
	http://127.0.0.1:5000/news/events/pyohio-2016
	http://127.0.0.1:5000/pt_BR/news/events/pyohio-2016
	http://127.0.0.1:5000/zh_TW/news/events/pyohio-2016


Error number: 1
Status code or error type: 404
https://github.com/pybee/pybee.github.io/wiki/So-you-want-to-be-a-BeeWare-GSoC-student%3F
-----------------------------------------------------------------------------------------
	http://127.0.0.1:5000/ar_AR/news/buzz/2017-google-summer-of-code
	http://127.0.0.1:5000/ar_AR/news/buzz
	http://127.0.0.1:5000/de_DE/news/buzz/2017-google-summer-of-code
	http://127.0.0.1:5000/de_DE/news/buzz
	http://127.0.0.1:5000/es/noticias/zumbido/2017-google-summer-of-code
	http://127.0.0.1:5000/es/noticias/zumbido
	http://127.0.0.1:5000/news/buzz/2017-google-summer-of-code
	http://127.0.0.1:5000/news/buzz
	http://127.0.0.1:5000/pt_BR/news/buzz/2017-google-summer-of-code
	http://127.0.0.1:5000/pt_BR/news/buzz
	http://127.0.0.1:5000/zh_TW/news/buzz/2017-google-summer-of-code
	http://127.0.0.1:5000/zh_TW/news/buzz

Referencing pages by name rather than path

Sometimes the location of pages in pybee.org change, and so the links break.

If lektor has the ability to refer to a page by name instead of path, they might break less!

This ticket is: investigate if lektor has this ability, and if so start adding it to our docs here.

Somehow, registering for the enthusiasts' newsletter didn't work through the website

Going directly to pybee.us13.list-manage.com/subscribe/post?u=80484e69d1f766a4f4477b680&id=fe4d05bfd7 fixed it (for me).

I haven't see a captcha on pybee.org, but got one on the URL above. Maybe that's part of the problem.

The error said something about too many retries for my email address, and trying again in 5 minutes. That didn't help.

Text-wrapping bug

When description wraps to multiple lines, the UI breaks.

This is particularly problematic because with different window sizes, the text wraps differently.

I noticed this by attempting to make a long description text for cricket.

Noted in #7.

Document translation of content in templates using databags

https://pybee.org/contributing/how/translations/

See Lektor Docs and [this file](https://github.com/pybee/pybee.github.io/blob/lektor/databags/translate.ini

The copyright notice still says 2016

I was reading through the first collaboration guide and noticed something wasn't quite right.

I know this isn't that big of a deal, but I just wanted to let you know in case you weren't aware of it :)

Cheers! 🐍 🐝

Identify and update all broken links

The current Travis CI builds are breaking due to tests we have to make sure URLs are valid and working.

Your mission should you choose to accept it:

• Go to the latest TravisCI build, and find the URLs that are having issues
• Work out how to best update them
  • has the website gone away? Is there an Internet Archive of the page? Replace it!
  • is there a spelling error in the URL? Correct it!
  • something seriously wrong? Find a Apiarist and ask them!
• Make a Pull Request to correct the issue

At PyCon US? Find a friendly apiarist and ask them! They're currently in Room 21 (but they might move. Check twitter for updates. Contribution earns you a shiny coin! ✨

Spruce up the design.

The design for the website is the very least I could manage poking around with Bootstrap. You may have noticed - I'm not a designer :-)

If you're a front-end inclined person, I've love to see a new design for the project. This includes the main pybee.org site, as well as the individual project pages.

Update readme (lektor version)

Lektor at least for linux/osx) is python3 ready. For windows python 3 still has some bugs and tests that fail.

Still, maybe we can update this

If you want to test out a change before you submit it, download and install Lektor (note that Lektor is still using Python 2.7):
$ pip install lektor

And also I would like to ask if it is possible to include a conda option (disclaimer, I built/maintain the Lektor conda-forge packages). Its fine if you guys don't agree. Lektor conda pakcages include a patch for windows and python3 (but I have not tested it deeply)

$ conda install lektor

The button text isn't visible properly

Screenshot attached for reference.

"keep-informed" form not working with Disconnect add-on on Firefox

Clicking Subscribe on the form on the keep-informed page leads to no effect, no mail, no user feedback. Tested on Firefox 48.0.1.
The form is also rendered strange (no Bootstrap look), it looks like it falls back to default.
I also tested the form on Chrome, Opera and Safari, all three worked (and looked) as expected.

Translation to pt_BR.

We can use this issue to organize the translation.

I will translate the following pages:

Work on
http://pybee.org/community/team/
http://pybee.org/community/getting-help/

Waiting for Commit
http://pybee.org/community/behavior/
http://pybee.org/community/behavior/code-of-conduct/
http://pybee.org/community/behavior/making-a-coc-complaint/
http://pybee.org/community/behavior/changes/

Done
http://pybee.org/contact/
http://pybee.org/contact/media/
http://pybee.org/community/
http://pybee.org/contributing/membership/ - (incomplete)
http://pybee.org/contributing/challenge-coins/
http://pybee.org/contributing/core-team/
http://pybee.org/contributing/how/
http://pybee.org/contributing/
http://pybee.org/contributing/what/
http://pybee.org/contributing/first-time/ (and sub pages)

---

There is also a pyladie doing the "Using GitHub" page. Yay \0/
http://pybee.org/contributing/first-time/github/

Bugs in the website menu

I noticed a couple of bugs on the website menu:

• The menu position is fixed, so it can't be scrolled (possibly hiding bottom items, specially in landscape mode)
• I can't change to another language due to the dropdown menu opening mostly out of the bottom of the screen

In the screenshot below (captured on Google Chrome, in "responsive" mode), you can see how the menu is visible in portrait mode and how the language selection menu is not accessible (at least on Google Chrome):

Add list of out of date pages

From @freakboy3742

@goanpeca A random thought, if you’re looking for something else to play with - The banner saying “this page is out of date” is great as a warning to someone browsing content, but if I’m looking for a way to contribute, a single summary page that lists all the out-of-date pages on the site would be amazing.

i.e., somewhere under the “how do I contribute” section, if I know German, I can go to the “german translation” page, and get a list of the 20 pages that are known to be out of date or missing translations.

Up For Grabs link on VOC page is pointing to the wrong tag

The Up For Grabs link on http://pybee.org/project/projects/bridges/voc/ is pointing to https://github.com/pybee/voc/issues?q=is%3Aissue+is%3Aopen+label%3Aup-for-grabs. I believe it should be pointing to https://github.com/pybee/voc/issues?q=is%3Aissue+is%3Aopen+label%3Aup-fo-grabs (the label should read up-fo-grabs as opposed to up-for-grabs).

Translation to Russian

Hello! I'd like to start translating https://pybee.org to Russian.

Now working on the main page.

P.S. Really interested in Python. Found your project reading an answer on the SO yesterday. Before that only heard of Kivy as a framework for mobile development.

Draft translation teams document

from @freakboy3742: A related activity - there's not much use having a team unless people know it exists; so we probably need some documentation for how to get started on translation, how to contribute, what you need to do to join the translation team, etc. Care to take a swing at drafting something?

Use better formatted issue pages

Use the following issue links in https://pybee.org/contributing/how/

https://github.com/issues?q=user%3Apybee+label%3Aup-for-grabs+is%3Aopen&type=Issues
https://github.com/issues?q=user%3Apybee+label%3Afirst-timers-only+is%3Aopen&type=Issues

beeware.org

Based on a conversation with @freakboy3742 this ticket is to go through the sitemap of pybee.org and identify which pages should belong to new subdomains such as docs.beeware.org, contribute.beeware.org, etc.

Here's a picture of the white board outlining the design with subdomains.

Fix links on Contributing page

If you look at https://pybee.org/contributing/how/ you'll notice the links in the "Code Contribution" section look a little weird.

There are other examples on that page for how to fix the links.

https://github.com/pybee/pybee.github.io/blob/lektor/content/contributing/how/contents.lr#L56

The future of web & mobile app development - PWA

It seems that Progressive Web Apps (PWA) will become popular in the future. Is the BeeWare project aware of this movement and will consider that on it's roadmap?

Hardcoded text in templates

There are some pages that hardcode text (home being one example), so my question is regarding the strategy we should/could use:

1. Move the html from the template to body of the home page, so it can be translated
2. Add a bit of structure to the home model page (for the home page example)
3. Use databags for the content inside the home page and alternatives on bags
4. Use flowblocks in the home page

Add language selector

I think would be a good addition to have a language selector or, perhaps, a page with a link to browse to existing translations.

Broken link in "Tutorial: Preparing your Environment for Batavia Development"

https://batavia.readthedocs.io/en/latest/intro/tutorial-0.html

The "on our Environment setup guide" link leads to http://pybee.org/contributing/first-time/setup/ which does not exist. It should lead to http://pybee.org/contributing/how/first-time/setup/

The language menu shouldn't be translated

The language menu should be more like the one in Wikipedia, where no matter which language is the page you're visiting, the links for other languages are written in those languages.

As it is right now, there is a bit of an accessibility problem: if someone happens to follow a link to, say, the German version, they have to either know what "Sprachen" means or know the structure of the website to access their language.

We should probably consider making the "Languages" item of the menu untranslated as well, as the probability of random people knowing what "Languages" mean is likely higher for English than for other languages.

Any thoughts?

Beeware webpage's broken links

Team, I would like to bring to your attention that both links for getting started and quick start are broken at the project webpage.

Document package updating process

Scope: BDFN, but helpful for repeatability. Includes npm and pypi, etc. Also interlinking of projects and dependencies

pybee.org homepage console error

I noticed the following error in my console on your homepage:
Uncaught Error: Bootstrap tooltips require Tether (http://github.hubspot.com/tether/)

Don't know if you can fix it or if it's on hubspot side.
If this is irrelevant, feel free to close it. It's like a -9999 priority issue.

Cheers! 🍺 or shoud I say 🐝r!

Broken Link in 'Challenge Coins' page.

The link to MaxCDN blog page seems to have moved. Can this be replaced with a Wayback machine link?

Broken link: https://www.maxcdn.com/blog/beeware-be-sticky/
Archive Link: https://web.archive.org/web/20170923205703/https://www.maxcdn.com/blog/beeware-be-sticky/

Documentation overview/pointers for complete new-bees

Going to the home page, I don't know where to start. Russ explained there is no single point of entry, but the newbie needs to know that and how to make the initial decision about where to start.

Once I get further along and have an understanding of this I might be able to come back and make a pull request.