Skip to content
This repository has been archived by the owner on Dec 20, 2023. It is now read-only.

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
egabancho committed Apr 19, 2019
0 parents commit 72e7c1c
Show file tree
Hide file tree
Showing 56 changed files with 3,147 additions and 0 deletions.
15 changes: 15 additions & 0 deletions .dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
.git
*.gitignore

*.mo
*.pyc
*.swp
*.swo
*.~

.dockerignore
Dockerfile
docker-compose.yml
docker-compose-dev.yml

Procfile*
40 changes: 40 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# -*- coding: utf-8 -*-
#
# Copyright (C) 2019 Esteban J. G. Gabancho.
#
# Flask-SSO-SAML is free software; you can redistribute it and/or modify it
# under the terms of the MIT License; see LICENSE file for more details.

root = true

[*]
indent_style = space
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
charset = utf-8

# Python files
[*.py]
indent_size = 4
# isort plugin configuration
known_first_party = flask_sso_saml
multi_line_output = 2
default_section = THIRDPARTY
skip = .eggs

# RST files (used by sphinx)
[*.rst]
indent_size = 4

# CSS, HTML, JS, JSON, YML
[*.{css,html,js,json,yml}]
indent_size = 2

# Matches the exact files either package.json or .travis.yml
[{package.json,.travis.yml}]
indent_size = 2

# Dockerfile
[Dockerfile]
indent_size = 4
62 changes: 62 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]

# Idea software family
.idea/

# C extensions
*.so

# Distribution / packaging
.Python
env/
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
*.egg-info/
.installed.cfg
*.egg

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*,cover

# Translations
*.mo

# Django stuff:
*.log

# Sphinx documentation
docs/_build/

# PyBuilder
target/

# Vim swapfiles
.*.sw?
46 changes: 46 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
notifications:
email: false
sudo: false
language: python
matrix:
fast_finish: true
allow_failures:
- env: REQUIREMENTS=devel
addons:
apt:
update: true
cache:
- pip
env:
- REQUIREMENTS=lowest
- REQUIREMENTS=release DEPLOY=true
- REQUIREMENTS=devel
python:
- '2.7'
- '3.6'
before_install:
- sudo apt-get install -y libxml2-dev libxmlsec1-dev
- travis_retry pip install --upgrade pip setuptools py
- travis_retry pip install twine wheel coveralls requirements-builder
- requirements-builder -e all --level=min setup.py > .travis-lowest-requirements.txt
- requirements-builder -e all --level=pypi setup.py > .travis-release-requirements.txt
- requirements-builder -e all --level=dev --req requirements-devel.txt setup.py >
.travis-devel-requirements.txt
install:
- travis_retry pip install -r .travis-${REQUIREMENTS}-requirements.txt
- travis_retry pip install -e .[all]
script:
- "./run-tests.sh"
after_success:
- coveralls
deploy:
provider: pypi
user: egabancho
password:
secure: JocmwQw5cwPOKthchiFKxfh9+pA/tvBVzYRBRckNNy7z5/xKYWqStOs8b7ZIWFFOQ03x9Zuf8iFYQaH3616CG+Bob4f/7xKfmUzE7cCWlMnJzLZIXtLkFbm0U+qlW8BjJySZBsDFkZUVbgU4emP3NL63ue2iPlbq8xMUOZ/urrsJC3XEvOycSqU2s1bE4nF7l6qmzt6OsynJ/4v7sKo/XfzKewsdOBuMqXvLcevP+1ftKpd4LPJldxf3x9SdhrD2aO73j3FDd8u+RseWPCpyGwHAwwN8B+oK+EpZMK1JMS1uDV3Wsessq5QRt5GO6NfJCXG8qaHiIphOZMs/jOtJLAh/Kn7UiSEMzz46ITyxr/loM74BWaB/1QhIlzhvur6w5klZXcatIic64a8ea0qTsP0TGeNbtFB/8nmuKFeaT8JyFg+0qTZVg/KPsJVRRr//V3ISXWc8/7Fu+jrgJkk3MHzhrBkzliCx8DK4f70CtKNtOOpZs7UQbz3AKL+vcJSfCbPiwUMs581SzBV7WUNPbVPsGHvalcw5N+10DlYVDI2LHWf7SilbqHySbBLnHrKh1gJQ74QW8r4WHifNbOpGJ+oDlo4a6IdWL9cFeG+FbCkbsmnWOU+mTLwTxmSZAWQcNLdFpNyN8KKTYmGukvv1zZGS1lhDDIsSQc93Jeyw/3o=
distributions: compile_catalog sdist bdist_wheel
on:
tags: true
python: '2.7'
repo: egabancho/flask-sso-saml
condition: "$DEPLOY = true"
12 changes: 12 additions & 0 deletions AUTHORS.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
..
Copyright (C) 2019 Esteban J. G. Gabancho.
Flask-SSO-SAML is free software; you can redistribute it and/or modify
it under the terms of the MIT License; see LICENSE file for more details.

Authors
=======

Flask extension that provides SSO SAML integration.

- Esteban J. G. Gabancho <egabancho@gmail.com>
12 changes: 12 additions & 0 deletions CHANGES.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
..
Copyright (C) 2019 Esteban J. G. Gabancho.
Flask-SSO-SAML is free software; you can redistribute it and/or modify
it under the terms of the MIT License; see LICENSE file for more details.

Changes
=======

Version 0.1.0 (released TBD)

- Initial public release.
118 changes: 118 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
Contributing
============

Contributions are welcome, and they are greatly appreciated! Every
little bit helps, and credit will always be given.

Types of Contributions
----------------------

Report Bugs
~~~~~~~~~~~

Report bugs at https://github.com/egabancho/flask-sso-saml/issues.

If you are reporting a bug, please include:

* Your operating system name and version.
* Any details about your local setup that might be helpful in troubleshooting.
* Detailed steps to reproduce the bug.

Fix Bugs
~~~~~~~~

Look through the GitHub issues for bugs. Anything tagged with "bug"
is open to whoever wants to implement it.

Implement Features
~~~~~~~~~~~~~~~~~~

Look through the GitHub issues for features. Anything tagged with "feature"
is open to whoever wants to implement it.

Write Documentation
~~~~~~~~~~~~~~~~~~~

Flask-SSO-SAML could always use more documentation, whether as part of the
official Flask-SSO-SAML docs, in docstrings, or even on the web in blog posts,
articles, and such.

Submit Feedback
~~~~~~~~~~~~~~~

The best way to send feedback is to file an issue at
https://github.com/egabancho/flask-sso-saml/issues.

If you are proposing a feature:

* Explain in detail how it would work.
* Keep the scope as narrow as possible, to make it easier to implement.
* Remember that this is a volunteer-driven project, and that contributions
are welcome :)

Get Started!
------------

Ready to contribute? Here's how to set up `flask-sso-saml` for local development.

1. Fork the `egabancho/flask-sso-saml` repo on GitHub.
2. Clone your fork locally:

.. code-block:: console
$ git clone git@github.com:your_name_here/flask-sso-saml.git
3. Install your local copy into a virtualenv. Assuming you have
virtualenvwrapper installed, this is how you set up your fork for local
development:

.. code-block:: console
$ mkvirtualenv flask-sso-saml
$ cd flask-sso-saml/
$ pip install -e .[all]
4. Create a branch for local development:

.. code-block:: console
$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.

5. When you're done making changes, check that your changes pass tests:

.. code-block:: console
$ ./run-tests.sh
The tests will provide you with test coverage and also check PEP8
(code style), PEP257 (documentation), flake8 as well as build the Sphinx
documentation and run doctests.

6. Commit your changes and push your branch to GitHub:

.. code-block:: console
$ git add .
$ git commit -s
-m "component: title without verbs"
-m "* NEW Adds your new feature."
-m "* FIX Fixes an existing issue."
-m "* BETTER Improves and existing feature."
-m "* Changes something that should not be visible in release notes."
$ git push origin name-of-your-bugfix-or-feature
7. Submit a pull request through the GitHub website.

Pull Request Guidelines
-----------------------

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests and must not decrease test coverage.
2. If the pull request adds functionality, the docs should be updated. Put
your new functionality into a function with a docstring.
3. The pull request should work for Python 2.7, 3.5 and 3.6. Check
https://travis-ci.org/egabancho/flask-sso-saml/pull_requests
and make sure that the tests pass for all supported Python versions.
8 changes: 8 additions & 0 deletions INSTALL.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Installation
============

Flask-SSO-SAML is on PyPI so all you need is:

.. code-block:: console
$ pip install flask-sso-saml
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (C) 2019 Esteban J. G. Gabancho.

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
30 changes: 30 additions & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# -*- coding: utf-8 -*-
#
# Copyright (C) 2019 Esteban J. G. Gabancho.
#
# Flask-SSO-SAML is free software; you can redistribute it and/or modify it
# under the terms of the MIT License; see LICENSE file for more details.

include *.rst
include *.sh
include *.txt
include .dockerignore
include .editorconfig
include .tx/config
include LICENSE
include babel.ini
include pytest.ini
prune docs/_build
recursive-include docs *.bat
recursive-include docs *.py
recursive-include docs *.rst
recursive-include docs *.txt
recursive-include docs Makefile
recursive-include examples *.html
recursive-include examples *.py
recursive-include examples *.sh
recursive-include flask_sso_saml/translations *.po *.pot *.mo
recursive-include tests *.crt
recursive-include tests *.key
recursive-include tests *.py
recursive-include tests *.xml

0 comments on commit 72e7c1c

Please sign in to comment.