-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Hirotaka Wakabayashi
committed
Mar 6, 2019
0 parents
commit 520fdcc
Showing
60 changed files
with
7,434 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
## Additional Information | ||
(The following information is very important in order to help us to help you. Omission of the following details may delay your support request or receive no attention at all.) | ||
|
||
- Version of python (python --version) | ||
``` | ||
``` | ||
|
||
- Version of K2HR3 OpenStack Notification Listener (k2hr3-osnl -v) | ||
``` | ||
``` | ||
|
||
- System information (uname -a) | ||
``` | ||
``` | ||
|
||
- Distro (cat /etc/issue) | ||
``` | ||
``` | ||
|
||
## Details about issue |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
## Relevant Issue (if applicable) | ||
(If there are Issues related to this PullRequest, please list it.) | ||
|
||
## Details | ||
(Please describe the details of PullRequest.) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,127 @@ | ||
# | ||
# K2HR3 OpenStack Notification Listener | ||
# | ||
# Copyright 2018 Yahoo! Japan Corporation. | ||
# | ||
# K2HR3 is K2hdkc based Resource and Roles and policy Rules, gathers | ||
# common management information for the cloud. | ||
# K2HR3 can dynamically manage information as "who", "what", "operate". | ||
# These are stored as roles, resources, policies in K2hdkc, and the | ||
# client system can dynamically read and modify these information. | ||
# | ||
# For the full copyright and license information, please view | ||
# the licenses file that was distributed with this source code. | ||
# | ||
# AUTHOR: Hirotaka Wakabayashi | ||
# CREATE: Tue Sep 11 2018 | ||
# REVISION: | ||
# | ||
|
||
# Byte-compiled / optimized / DLL files | ||
__pycache__/ | ||
*.py[cod] | ||
*$py.class | ||
|
||
# C extensions | ||
*.so | ||
|
||
# Distribution / packaging | ||
.Python | ||
env/ | ||
build/ | ||
develop-eggs/ | ||
dist/ | ||
downloads/ | ||
eggs/ | ||
.eggs/ | ||
lib/ | ||
lib64/ | ||
parts/ | ||
sdist/ | ||
var/ | ||
wheels/ | ||
*.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 | ||
.hypothesis/ | ||
.pytest_cache/ | ||
|
||
# Translations | ||
*.mo | ||
*.pot | ||
|
||
# Django stuff: | ||
*.log | ||
local_settings.py | ||
|
||
# Flask stuff: | ||
instance/ | ||
.webassets-cache | ||
|
||
# Scrapy stuff: | ||
.scrapy | ||
|
||
# Sphinx documentation | ||
docs/_build/ | ||
|
||
# PyBuilder | ||
target/ | ||
|
||
# Jupyter Notebook | ||
.ipynb_checkpoints | ||
|
||
# pyenv | ||
.python-version | ||
|
||
# celery beat schedule file | ||
celerybeat-schedule | ||
|
||
# SageMath parsed files | ||
*.sage.py | ||
|
||
# dotenv | ||
.env | ||
|
||
# virtualenv | ||
.venv | ||
venv/ | ||
ENV/ | ||
|
||
# Spyder project settings | ||
.spyderproject | ||
.spyproject | ||
|
||
# Rope project settings | ||
.ropeproject | ||
|
||
# mkdocs documentation | ||
/site | ||
|
||
# mypy | ||
.mypy_cache/ | ||
|
||
# | ||
# VIM modelines | ||
# | ||
# vim:set ts=4 fenc=utf-8: | ||
# |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
# | ||
# K2HR3 OpenStack Notification Listener | ||
# | ||
# Copyright 2018 Yahoo! Japan Corporation. | ||
# | ||
# K2HR3 is K2hdkc based Resource and Roles and policy Rules, gathers | ||
# common management information for the cloud. | ||
# K2HR3 can dynamically manage information as "who", "what", "operate". | ||
# These are stored as roles, resources, policies in K2hdkc, and the | ||
# client system can dynamically read and modify these information. | ||
# | ||
# For the full copyright and license information, please view | ||
# the licenses file that was distributed with this source code. | ||
# | ||
# AUTHOR: Hirotaka Wakabayashi | ||
# CREATE: Tue Sep 11 2018 | ||
# REVISION: | ||
# | ||
|
||
language: python | ||
dist: xenial | ||
python: | ||
- 3.7 | ||
- 3.6 | ||
- 3.5 | ||
|
||
install: make init | ||
|
||
script: | ||
- make lint test-with-version coverage docs dist install | ||
|
||
deploy: | ||
provider: pypi | ||
user: "hiwakaba" | ||
password: ${TEST_PYPI_TOKEN} | ||
on: | ||
tags: true | ||
server: "https://test.pypi.org/legacy/" | ||
distributions: "sdist bdist_wheel" | ||
skip_existing: true | ||
|
||
# | ||
# VIM modelines | ||
# | ||
# vim:set ts=4 fenc=utf-8: | ||
# | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
======= | ||
Credits | ||
======= | ||
|
||
Development Lead | ||
---------------- | ||
|
||
* Hirotaka Wakabayashi <[email protected]> | ||
|
||
Contributors | ||
------------ | ||
|
||
* Takeshi Nakatani <[email protected]> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,123 @@ | ||
============ | ||
Contributing | ||
============ | ||
|
||
Contributions are welcome, and they are greatly appreciated! Every little bit | ||
helps, and credit will always be given. | ||
|
||
You can contribute in many ways: | ||
|
||
Types of Contributions | ||
---------------------- | ||
|
||
Report Bugs | ||
~~~~~~~~~~~ | ||
|
||
Report bugs at https://github.com/yahoojapan/k2hr3_osnl/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" and "help | ||
wanted" is open to whoever wants to implement it. | ||
|
||
Implement Features | ||
~~~~~~~~~~~~~~~~~~ | ||
|
||
Look through the GitHub issues for features. Anything tagged with "enhancement" | ||
and "help wanted" is open to whoever wants to implement it. | ||
|
||
Write Documentation | ||
~~~~~~~~~~~~~~~~~~~ | ||
|
||
K2HR3 OpenStack Notification Listener could always use more documentation, whether as part of the | ||
official K2HR3 OpenStack Notification Listener 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/yahoojapan/k2hr3_osnl/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 `k2hr3_osnl` for local development. | ||
|
||
1. Fork the `k2hr3_osnl` repo on GitHub. | ||
2. Clone your fork locally:: | ||
|
||
$ git clone [email protected]:your_name_here/k2hr3_osnl.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:: | ||
|
||
$ cd k2hr3_osnl/ | ||
$ pip3 install pipenv | ||
$ python3 -m pipenv install -dev --python /path/to/python3 | ||
$ pipenv shell | ||
|
||
4. Create a branch for local development:: | ||
|
||
(k2hr3_osnl) $ 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 flake8, | ||
mypy, pylint and the tests, including testing other Python versions | ||
with make lint test | ||
|
||
Make sure you are in virtual environment:: | ||
|
||
(k2hr3_osnl) $ make lint test | ||
|
||
6. Commit your changes and push your branch to GitHub:: | ||
|
||
(k2hr3_osnl) $ git add . | ||
(k2hr3_osnl) $ git commit -m "Your detailed description of your changes." | ||
(k2hr3_osnl) $ 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. | ||
2. If the pull request adds functionality, the docs should be updated. Put | ||
your new functionality into a function with a docstring, and add the | ||
feature to the list in README.rst. | ||
3. The pull request should work for Python 3.5, 3.6 and 3.7. Check | ||
https://travis-ci.org/yahoojapan/k2hr3_osnl/pull_requests | ||
and make sure that the tests pass for all supported Python versions. | ||
|
||
Tips | ||
---- | ||
|
||
To run a subset of tests:: | ||
|
||
|
||
$ make test | ||
|
||
Deploying | ||
--------- | ||
|
||
A reminder for the maintainers on how to deploy. | ||
Make sure all your changes are committed (including an entry in HISTORY.rst). | ||
Then visit the release page at https://github.com/yahoojapan/k2hr3_osnl/releases | ||
and create a new release note. | ||
|
||
Travis will then deploy to PyPI if tests pass. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
======= | ||
History | ||
======= | ||
|
||
0.9.0 (2019-02-28) | ||
------------------- | ||
|
||
* First release on PyPI. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
MIT License | ||
|
||
Copyright (c) 2018 Yahoo Japan Corporation | ||
|
||
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. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
include AUTHORS.rst | ||
include CONTRIBUTING.rst | ||
include HISTORY.rst | ||
include LICENSE | ||
include README.rst | ||
|
||
recursive-include tests * | ||
recursive-exclude * __pycache__ | ||
recursive-exclude * *.py[co] | ||
|
||
recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif |
Oops, something went wrong.