LibrarPy

A webapp to track technical library lending amongst Portland PyLadies

I. Purpose and Introduction
II. Code of Conduct
III. How to get started
IV. What has been done
V. What needs doing
VI. Recommended Tutorials
VII. Attribution

I. Purpose and Introduction

The purpose of the app is to manage the vast quantity of technical books which the PyLadies have been given, or books which members own and are happy to lend. We estimate that that number of books exceeds a hundred, and once people start adding theirs that number will only increase.

This is a webapp written with the web framework Flask using primarily Python as well as HTML and CSS, which includes the Skeleton stylesheet. There is also a touch of Jinja2 for templating (squishing formatting stuff into Python) as well as PostgreSQL for the database. As of the publication of this document (30 April 2016), the barest function of it works, which includes adding a book and seeing a list of all books available.

II. Code of Conduct

So you want to contribute! AMAZING, THANK YOU. Please see our Code of Conduct before jumping in; first and foremost we are trying to make this a safe space for PyLadies to hack and code and work together. Further, we are looking for contributions from women only, inclusive of trans women.

III. How to get started

First you'll want to pull down this git repository, which contains this README and all the code. If you have not used Git or Github before, welcome! We've got a tutorial for you (listed below in the Tutorials section) and we'd love to help you in person too at our Saturday Code and Learn events. Another easy way to get started helping out is to create issues for the pieces listed in the What Needs To Be Done section. For this, you only need a Github account!

First, with your Github account, fork the repo. Click the Fork button as demonstrated below, which will then make a copy of the repo at THIS state, on the Master branch.

Then, pull the repo down locally. In your terminal, you can do this by typing git clone git@github.com:<YOUR GITHUB USERNAME HERE>/pyladiespdx-books.git. This will make a directory in your current location which contains all the files and directories you see here. We've got tutorials below, and we're also happy to show you, so please reach out via our meetup if you'd like to talk more about this!

Code will be approved by Pull Request only. This is to emulate as close to an industry production-standard environment as possible. To best contribute via PR (pull request), please use the following workflow:

1. Fork this repo at this level. github.com/rachelkelly/pyladiespdx-books at the Master branch.
2. Pull the repo down locally - this means to clone your OWN fork. git clone git@github.com:<YOUR GITHUB USERNAME HERE>/pyladiespdx-books.git
3. Create a descriptive branch name for the changes you intend to make. An example might be README-typo-fix. So this would be git checkout -b README-typo-fix to create and move immediately within the branch.
4. Make desired changes to code.
5. Add changed files, commit files with a descriptive, imperative form commit message, and push to your own fork.
6. At Github (not locally, & not at the command line), on your OWN fork, a green Create Pull Request button will appear. Go ahead and click this. The most important point on the ensuing screen is to make sure that the REMOTE and the BRANCH which you are creating the Pull Request to and from are accurate. The PR should be going to rachelkelly/pyladiespdx-books on the branch name you created, and it must come from your fork of the repo on the branch name you created. This PR will automatically create the branch on the rachelkelly/ repo.
7. The owner of the rachelkelly/ repo will either approve or turn down your PR with comments as to what needs to be fixed. Often it's as simple as clarifying your commit message, or asking for more in-line explanatory comments!

IV. What has been done

• Initial database setup
• Heroku webapp creation and linkage
• Virtualenv creation and complete requirements.txt
• Views (in the sense of what the pages will look like) begun
• Stylesheet
• Capacity to add new books with genuine connection to database
• HTML-capable, DB-drawn list of books
• MIT license added
• Adapted Contributor Covenant for CODE_OF_CONDUCT.md

V. What NEEDS doing

• probably always cleaning up this document :)
• change to Bootstrap CSS instead of Skeleton - it is more full-featured
• Authorization (this has been started)
• List of books by holder
• Logged-in user can request a book
• Transfer ownership of book (a. user requests book. b. owner says ok. c. owner says "ok the book is in their hands" or some such process)
• Set up email alerts for book requests
• Set up email reminders two weeks (or some number of weeks!)
  • both of these can be done with smtp python modules probably!
• Write a list of rules
• Tests

VI. Tutorials

Please note, you do not have to do any of these to contribute if you feel happy and familiar with them, but if you want to learn more about these things here are some resources that have been battle-tested by a bunch of us here at PyLadies PDX

• Djangogirls Python Tutorial, which starts at the beginning and introduces Python. Please learn as much as you'd like to of the Django portion Django, which is another kind of Python web framework like Flask is, which means some of it will be different, but which also uses the foundational structure of Model View Controller.
• Miguel Grinberg's Flask tutorial
• Codecademy's HTML/CSS beginner tutorial. Their Make A Website.
• The Official PostgreSQL Tutorial
• First introduction to Github
• Further introduction to Git, the underlying tool behind modern source control - you can get as in depth or referential with this as you like.
• exercism as a way to get started understanding how tests work and as samples for how to write them, and how to write FOR them. Particularly we recommend the Python exercism track, though many of the languages' problem sets are good.

VII. Attribution

This app was originally created by Juliana Arrighi and Rachel Kelly in 2014. Code of Conduct adapted from Coraline Ada Ehmke's [Contributor Covenant])(http://contributor-covenant.org/). PyLadies PDX is the Portland arm of the international women's group PyLadies, a group of women Python programmers. Find out more at our Meetup.