Skip to content

Commit

Permalink
Merge pull request #39 from CedricCabessa/geny
Browse files Browse the repository at this point in the history 
Move to geny organisation

fixes #30
  • Loading branch information
@CedricCabessa
CedricCabessa committed Aug 8, 2015
2 parents e0acde6 + 1df37d6 commit 2f59531
Show file tree
Hide file tree
Showing 39 changed files with 988 additions and 254 deletions.
14 changes: 0 additions & 14 deletions COPYING
View file

This file was deleted.

202 changes: 202 additions & 0 deletions LICENSE
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,202 @@

Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
144 changes: 101 additions & 43 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,33 +1,100 @@
Multi project Github PullRequest integration for Slack
======================================================
# gm_pr: A multi project Github pull request viewer

Slack setup:
* Add a "Incomming webhook" and copy the url in gm_pr.settings.SLACK_URL
the channel do not matter as it will be overrided in the script

* Add a "Slash command"
* use the GET method
* the url is where you deployed this django app followed by "/bot"
* copy the token in gm_pr.settings.SLACK_TOKEN
If your project is spread over multiple git repositories, it can be hard to
keep track of all the open pull requests.

Script setup
* Configure the slack channel / projects list mapping in gm_pr.settings.PROJECTS_CHAN
The gm_pr project gives you a simple web page where you can see all the open
pull requests with the number of reviews, labels, milestones, etc

* Configure the github login / password
![screenshot](screenshot.png)

* WEB_URL is where you deployed this django app
As a bonus, we also have a slack bot :-)

Docker cmd:
something like:
## Installation

docker run --name=gm_pr -d -p 4280:8000 -v /var/www/gm_pr:/var/www/gm_pr gm_pr
The recommended method to run gm_pr is to use the docker image.

A Dockerfile is available in the "deploy" folder. Building and running the image
can be done in a few lines:

Manual instructions:
====================
```
cd deploy
docker build -t gm_pr .
docker run -v /path/to/gm_pr:/var/www/gm_pr --name gm_pr -p 8000:80 -d gm_pr
```

Now, you can simply point your browser to http://localhost:8000.

If you want to make gm_pr available on your external interface, configure a
reverse proxy with apache. You can use this snippet:

```
<Proxy http://localhost:8000/>
Order deny,allow
Allow from all
</Proxy>
ProxyPass /gm_pr http://localhost:8000
ProxyPassReverse /gm_pr http://localhost:8000
<Location /gm_pr/bot>
Require all granted
</Location>
```

## Configuration

2 files are used for configuration:

* gm_pr/settings.py: this is the standard Django configuration file
* gm_pr/settings_projects.py: contains everything related to your projects

### Django configuration

Refer to the django project if you want to change the configuration.
Normally you should only need to adjust a few settings:

**ALLOWED_HOSTS** You may want to add the name of your server if you use
the docker / apache configuration.

**STATIC_URL** Add the full URL to your static directory

### Gm_pr configuration

Open **gm_pr/settings_projects.py** and read the comments. You'll need to change
most of the configuration here, but the file is self-documenting.

### Slack configuration

You can see your pull requests from Slack.

You need to add a "slash command" in the slack settings:

* Open https://mydomain.slack.com/services/new/slash-commands
* Choose a command name, for eg: "/pr"
* For the URL, append "/bot/" to your gm_pr URL.
* In order to make things easy with the Django CSRF protection, you have to
choose the GET method.
* Copy the token and add it in **settings_project.py** (**SLACK_TOKEN**)
* click on "Save Integration"

Then you need to add a incoming-webhook to let the bot send messages to Slack:

* Open https://mydomain.slack.com/services/new/incoming-webhook
* Choose a channel (the bot will be able to override it, so it doesn't really
matter what you enter)
* Copy the webhook URL in **setting_project.py** (**SLACK_URL**)

Now, go to the channel related to your project and type "/pr". After a
few seconds the list of pull requests should appear in your channel.

## Hacking

You need to install django for python3 and celery.

Here is the command line for MacOS/homebrew

Prerequisites (MacOS/homebrew):
-------------------------------
```
brew doctor
brew update
Expand All @@ -37,40 +104,31 @@ pip3 install django
pip3 install django-celery
```

Configuring the web page only:
------------------------------
On Debian-like system

Edit gm_pr/settings.py.
Set the following:
```
sudo apt-get install python3-django python3-django-celery celeryd python3-sqlalchemy
```

* GITHUB_LOGIN
* GITHUB_PASSWORD
* ORG
* PROJECTS_CHAN

Run the following commands to start the server:
```
python3 manage.py migrate
python3 manage.py runserver 192.168.1.4:8000
python3 manage.py runserver
```

Run the following command in a new terminal:
```
celery -A gm_pr worker -l info --concurrency=20
python3 manage.py celeryd
```

Open the web page at http://localhost:8000

Open the web page at http://192.168.1.4:8000
# About gm_pr

Running in production mode:
---------------------------
To run in production mode, modify gm_pr/settings_production.py:
* add at least one host to ALLOWED_HOSTS (https://docs.djangoproject.com/en/stable/ref/settings#allowed-hosts)
* set STATIC_URL to a full url. An external webserver must serve files at this url.
Example: http://example.com/static/
* copy the contents of the gm_pr/static folder to the folder served at STATIC_URL.
* Run the "runserver" and "celeryd" commands, with the production config:
```
python3 manage.py runserver 192.168.1.4:8000 --settings gm_pr.settings_production &
python3 manage.py celeryd --setting=gm_pr.settings_production
```
Gm_pr is an open-source project distributed under the Apache license
version 2

If you like this project, click on the star button on github :-)

Feel free to send us issues, and of course PRs!!
Loading

0 comments on commit 2f59531

Please sign in to comment.