-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added sphinx-rtd theme and watchdog for better doc writing. Changed all .md files to .rst files because RTD supports it a little bit better, and mostly just to be consistent. Removed the old docs in place of a more full-featured set of docs. Cleaned up pydoc documentation as some of it didn't look quite right in the new theme. So that is all the changes.
- Loading branch information
1 parent
9b28c8c
commit bfab83f
Showing
28 changed files
with
1,018 additions
and
556 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,14 @@ | ||
======= | ||
Credits | ||
======= | ||
|
||
Development Leads | ||
----------------- | ||
|
||
* Logan Asher Jones <[email protected]> | ||
* Matt Patrick | ||
|
||
Contributors | ||
------------ | ||
|
||
None yet. Why not be the first? |
This file was deleted.
Oops, something went wrong.
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,92 @@ | ||
Brewtils Changelog | ||
================== | ||
|
||
2.3.0 | ||
----- | ||
Date: 1/26/18 | ||
|
||
New Features | ||
^^^^^^^^^^^^ | ||
- Added methods for interacting with the Queue API to RestClient and EasyClient | ||
- Clients and Plugins can now be configured to skip server certificate verification when making HTTPS requests | ||
- Timestamps now have true millisecond precision on platforms that support it | ||
- Added ``form_input_type`` to Parameter model | ||
- Plugins can now be stopped correctly by calling their ``_stop`` method | ||
- Added Event model | ||
|
||
Bug Fixes | ||
^^^^^^^^^ | ||
- Plugins now additionally look for ``ca_cert`` and ``client_cert`` in ``BG_CA_CERT`` and ``BG_CLIENT_CERT`` | ||
|
||
Other Changes | ||
^^^^^^^^^^^^^ | ||
- Better data integrity by only allowing certain Request status transitions | ||
|
||
2.2.1 | ||
----- | ||
Date: 1/11/18 | ||
|
||
Bug Fixes | ||
^^^^^^^^^ | ||
- Nested requests that reference a different beer-garden no longer fail | ||
|
||
2.2.0 | ||
----- | ||
Date: 10/23/17 | ||
|
||
New Features | ||
^^^^^^^^^^^^ | ||
|
||
- Command descriptions can now be changed without updating the System version | ||
- Standardized Remote Plugin logging configuration | ||
- Added domain-specific language for dynamic choices configuration | ||
- Added ``metadata`` field to Instance model | ||
|
||
Bug Fixes | ||
^^^^^^^^^ | ||
- Removed some default values from model ``__init__`` functions | ||
- System descriptors (description, display name, icon name, metadata) now always updated during startup | ||
- Requests with output type 'JSON' will now have JSON error messages | ||
|
||
Other changes | ||
^^^^^^^^^^^^^ | ||
- Added license file | ||
|
||
2.1.1 | ||
----- | ||
Date: 8/25/17 | ||
|
||
New Features | ||
^^^^^^^^^^^^ | ||
|
||
- Added ``updated_at`` field to ``Request`` model | ||
- ``SystemClient`` now allows specifying a ``client_cert`` | ||
- ``RestClient`` now reuses the same session for subsequent connections | ||
- ``SystemClient`` can now make non-blocking requests | ||
- ``RestClient`` and ``EasyClient`` now support PATCHing a ``System`` | ||
|
||
Deprecations / Removals | ||
^^^^^^^^^^^^^^^^^^^^^^^ | ||
- ``multithreaded`` argument to ``PluginBase`` has been superseded by ``max_concurrent`` | ||
- These decorators are now deprecated | ||
- ``@command_registrar``, instead use ``@system`` | ||
- ``@plugin_param``, instead use ``@parameter`` | ||
- ``@register``, instead use ``@command`` | ||
- These classes are now deprecated | ||
- ``BrewmasterSchemaParser``, instead use ``SchemaParser`` | ||
- ``BrewmasterRestClient``, instead use ``RestClient`` | ||
- ``BrewmasterEasyClient``, instead use ``EasyClient`` | ||
- ``BrewmasterSystemClient``, instead use ``SystemClient`` | ||
|
||
Bug Fixes | ||
^^^^^^^^^ | ||
- Reworked message processing to remove the possibility of a failed request being stuck in ``IN_PROGRESS`` | ||
- Correctly handle custom form definitions with a top-level array | ||
- Smarter reconnect logic when the RabbitMQ connection fails | ||
|
||
Other changes | ||
^^^^^^^^^^^^^ | ||
- Removed dependency on ``pyopenssl`` so there's need to compile any Python extensions | ||
- Request processing now occurs inside of a ``ThreadPoolExecutor`` thread | ||
- Better serialization handling for epoch fields | ||
|
This file was deleted.
Oops, something went wrong.
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,114 @@ | ||
.. highlight:: shell | ||
|
||
============ | ||
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/beer-garden/brewtils/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 | ||
~~~~~~~~~~~~~~~~~~~ | ||
|
||
Brewtils could always use more documentation, whether as part of the | ||
official Brewtils 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/beer-garden/brewtils/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 ``brewtils`` for local development. | ||
|
||
1. Fork the ``brewtils`` repo on GitHub. | ||
2. Clone your fork locally:: | ||
|
||
$ git clone [email protected]:your_name_here/brewtils.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:: | ||
|
||
$ mkvirtualenv brewtils | ||
$ cd brewtils/ | ||
$ python setup.py develop | ||
|
||
4. Create a branch for local development:: | ||
|
||
$ 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 and the tests, including testing other Python versions with tox:: | ||
|
||
$ flake8 brewtils test | ||
$ nosetests | ||
$ tox | ||
|
||
To get flake8 and tox, just pip install them into your virtualenv. | ||
|
||
6. Commit your changes and push your branch to GitHub:: | ||
|
||
$ git add . | ||
$ git commit -m "Your detailed description of your changes." | ||
$ 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 2.7, 3.5, and 3.6. Check | ||
https://travis-ci.org/beer-garden/brewtils/pull_requests | ||
and make sure that the tests pass for all supported Python versions. | ||
|
||
Tips | ||
---- | ||
|
||
To run a subset of tests:: | ||
|
||
$ nosetests test/models_test.py:SystemTest.test_instance_names | ||
|
Oops, something went wrong.