Commit Graph

45 Commits

Author SHA1 Message Date
gtema 7df00eef61 Switch back to LaunchPad for issue tracking
We move away from StoryBoard back to LaunchPad.

Change-Id: Ic18c514f2fb9e96e68d09b973448541a4ce65432
2023-10-31 11:41:55 +01:00
Stephen Finucane 3876f3f6d9 Update README to indicate COE resource/proxy support
We now have first class support for Magnum.

A unrelated typo is also corrected.

Change-Id: I5065d3a780bc3d530e22e1eb2619fe107741abec
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2023-01-31 14:48:31 +00:00
Stephen Finucane b1f15919e1 docs: Add overview of supported services to README
Change-Id: I401f58a65555aa397c14e2795e11d3e76047ba63
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2022-11-22 11:29:28 +00:00
Stephen Finucane 85a2f10159 Improve README to provide example of Resource usage
Provide a simple "hello world" example that includes details on using
the 'Resource' subclasses. References to 'clouds.yaml' are also moved
earlier in the doc since this is a pretty essential part of using
openstacksdk.

Change-Id: I6e7e6b5d9f54ec15b8e886b78649b50e02d38fc4
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2021-03-24 13:46:03 +00:00
Monty Taylor b98e7098c8 Move the history lesson into the docs
It's not really the most important thing now is it?

Change-Id: I3a595eb774bf04a53e1dd09484058ed148b6c122
2019-08-01 10:14:21 -04:00
Monty Taylor e702b020ca Fix README example for cloud layer
This was showing 'import openstack.cloud' but then using openstack
directly. Fix that.

Then, reorganize a little bit.

Change-Id: Iecb7cd02cc6648c6e78666da0d237fc28643d2ae
2019-08-01 10:04:10 -04:00
Monty Taylor 737bcb0eca Finish updating links to point to opendev
The redirects work, but it's nicer to just use opendev links
directly. Also, update shade, which is in openstack namespace
now.

Depends-On: https://review.opendev.org/654230
Depends-On: https://review.opendev.org/654233
Change-Id: Id559b79c2aefda50fa3ec0feedf6d8c52a687a75
2019-04-21 12:31:44 +00:00
melissaml 1bceca8b98 Change openstack-dev to openstack-discuss
Mailinglists have been updated. Openstack-discuss replaces openstack-dev.

Change-Id: I7daa0112dba3445f4901005006153784ed4dff9f
2018-12-14 20:53:18 +08:00
Monty Taylor 5b8ef64502
Update storyboard links to use name
storyboard now supports project name in the urls. Switch to using that
form, since it just looks nicer.

Change-Id: Ibb4185446392af68ddfcc9de4f4f76b44db676c5
2018-08-03 10:16:21 -05:00
wu.chunyang 8eb9a90724 Add release note link in README
Change-Id: I6058fa986729fc95d070940c6f00f33065477ced
2018-06-29 08:53:59 +00:00
Monty Taylor 9c31aeca60
Fix bugtracker and documentation references
These are all out of date.

Co-Authored-By: Sergey Skripnick <sskripnick@mirantis.com>
Change-Id: I7f59ec145946b316432357f3d0190b65157bcbfb
2018-04-25 13:17:02 +02:00
Zuul 9d1b8a2a78 Merge "Trivial: Update pypi url to new url" 2018-04-25 11:08:21 +00:00
melissaml c2cde29c18 Trivial: Update pypi url to new url
Pypi url changed from [1] to [2]

[1] https://pypi.python.org/pypi/<package>
[2] https://pypi.org/project/<package>

Change-Id: I398e0859f6c7c4975f00cf436505fccf5eb5ec4f
2018-04-21 04:31:16 +08:00
Kiseok Kim cc6dc84e72 Fix typo in README.rst
Trivial fix.

Change-Id: I8ce671350912879dcefd674da0d6dcd011f2c4db
2018-04-20 03:05:24 +00:00
Monty Taylor f44ed7ab35
Update python-openstacksdk references to openstacksdk
Now that the repo is renamed, update all of the references.
While we're at it, remote unused translation config.

Change-Id: Ib9f80eb809317483f83f79952470c2b57b2bb7c6
2018-03-23 12:31:24 -05:00
Monty Taylor 958a35a5ca
Remove openstack_cloud factory function
This is mostly mechanical as these are no longer needed.

Change-Id: I632675506bef591704068d17ec3dfad963a4c4b5
2018-01-31 11:26:02 -06:00
Zuul 9c8a528917 Merge "Move openstack_cloud helper functions" 2018-01-24 09:46:46 +00:00
Zuul 0b6eb7074d Merge "Fixed a few nits in the README" 2018-01-23 23:30:52 +00:00
Monty Taylor 3afec7512e
Fixed a few nits in the README
These were called out in an earlier review.

Change-Id: Ib1da2606c93782641a3d7a07a1aad9ddf331d208
2018-01-21 10:09:40 -06:00
Zuul ea26149db9 Merge "Update Release Notes links and add bugs links" 2018-01-21 15:58:24 +00:00
Monty Taylor e636890d59
Move openstack_cloud helper functions
We don't want these where they look like supported interfaces just yet.
Move them below openstack.cloud.

Change-Id: I653e5aaba8084e8c226fd0e787dfff01050e7a6c
2018-01-18 16:54:55 -06:00
chenpengzi 4bbbffcc20 Update Release Notes links and add bugs links
Change-Id: I20a1a5b7528a2d8bca74fef34984d246e8aa653a
2018-01-17 15:31:25 +08:00
Monty Taylor da2406bace
Rationalize logging helpers and docs
shade and openstacksdk each have a logging doc and a logging setup helper
function. They both basically do the same thing, and we have a TODO item
about collapsing them.

This moves openstack.utils.enable_logging to openstack.enable_logging
(leaving behind a compat piece at openstack.utils.enable_logging) It
adds the shade functionality to it, and also changes the behavior to
match shade's WRT behavior when no parameters are passed (defaults to
logging to stdout)

Update the codebase to call openstack._log.setup_logging instead of
logging.getLogger directly, as setup_logging attaches a NullHandler by
default.

Collapse the docs into a single document.

There were only two places where openstacksdk was already logging to
something other than 'openstack'. Collapse those down to 'openstack'
until we come up with a reason to break them out more logically.

Change-Id: I45fd5ffd18255450d38a1f56c80f5c157ea19ae3
2018-01-16 14:46:44 -06:00
Monty Taylor 535f2f48ff
Merge shade and os-client-config into the tree
This sucks in the git history for both projects, then moves their files
in place. It should not introduce any behavior changes to any of the
existing openstacksdk code, nor to openstack.config and openstack.cloud
- other than the name change.

TODO(shade) comments have been left indicating places where further
integration work should be done.

It should not be assumed that these are the final places for either to
live. This is just about getting them in-tree so we can work with them.

The enforcer code for reasons surpassing understanding does not work
with python setup.py build_sphinx but it does work with sphinx-build
(what?) For now turn it off. We can turn it back on once the build
sphinx job is migrated to the new PTI.

Change-Id: I9523e4e281285360c61e9e0456a8e07b7ac1243c
2017-11-15 09:03:23 -06:00
Monty Taylor a4ee1a3f09
Merge tox, tests and other support files
Change-Id: I5a4759e36089f1f4fab0c75412c94d051d8b16a7
2017-10-04 14:51:08 -05:00
lidong 0eecb4ba71 Update links in README
Change http://developer.openstack.org/sdks/python/openstacksdk/
to https://developer.openstack.org/sdks/python/openstacksdk/  in
README.rst

Change-Id: I19b2a8aeb625c682acf3ab23730af0c8556886b1
2017-08-22 16:09:21 +08:00
Brian Curtin 27f044df4f Remove requests from requirements
With the move to keystoneauth, we no longert depend on the requests
library for anything at runtime. We do still have one test, which is
valid, that depends on requests to ensure that
https://bugs.launchpad.net/python-openstacksdk/+bug/1428342 stays fixed.
This change moves requests to test-requirements and additionally removes
the list of dependencies in the README file, as it duplicates the only
place requirements are truly needed.

Change-Id: I6aa8e71573e685b2748150ea5cec946b65d525ae
2015-12-16 14:51:40 -06:00
Brian Curtin ffcc66a90d Update doc link in README
Update a reference to the old RTD docs to openstack.org

Change-Id: Ie4c2f7e3db80fed7ab3f575a234409facaa7c521
2015-12-10 12:14:32 -06:00
Terry Howe 27309f5bfc Minor changes to top level docs
Change-Id: Ie2a0242e19ec92c30c05a2ffb846766610be2472
2015-05-22 17:19:16 -07:00
Brian Curtin 481e17ab91 Add missing equal sign to README
Change-Id: Ie1b55ecb055e06d232674198dc52d0ad6a5517d5
2015-03-10 16:37:29 -05:00
TerryHowe 8379ad612e Convert user_name to username
This will greatly reduce the number of ksc to sdk differences.
Why fight it, everyone is used to username anyway.

Change-Id: Ie6e897c1baa3184af77510b98790196e8f069f5a
2015-02-23 21:43:32 +00:00
Brian Curtin d299da56cf Update README and setup text for PyPI
This change updates the README text that shows up on PyPI so we can get
a small example up there as well as the documentation link. It also
marks 3.4 as supported, since we've been testing that for a while now.

Change-Id: I28555eb4e121f35151afc8548adb3df166257814
Closes-Bug: 1420858
2015-02-11 10:25:48 -06:00
Terry Howe 3be44940eb Update README requirements
Change-Id: I4153eba6dd1031982414a3a106605a040cd13974
2014-10-07 16:03:53 -06:00
Steve Lewis 06e3502c3b Fixing path to generated documentation
Path to generated documentation was incorrect.

Change-Id: I49d14e85d717c14e6b3976b46fb6538c2a65d2f4
2014-09-05 16:31:22 -07:00
Terry Howe ecda673ca1 Resolve Ed's concerns on README
https://review.openstack.org/#/c/96253/4/README.rst

Change-Id: I8fbc39c0311baa193862b7ca06ee06b2fbd0a85f
2014-06-06 15:30:34 -06:00
Alex Gaynor 48492fd37b Fleshed out the README and removed dependency on babel
Change-Id: I65927ef6985ebdb46db08b9ac311a8d4df2706c6
2014-06-03 16:09:20 -07:00
Alex Gaynor 7c62969a31 Reorganize the index a bit to make the important content be at the top
Change-Id: If3392f8d837baf0038c5eefe079d77515cfc7cb5
2014-05-27 19:16:29 +00:00
Dean Troyer fcc7d7e1e6 Add Transport doc
Basic overview of the Transport class with some sample code.

Change-Id: I214f494da1f2674041ef0dd753cae4f3706966d9
2014-05-19 18:31:09 -06:00
Dean Troyer 6923b2cff9 Docs cleanup
Massage the default cookiecutter-provided structire to remove Sphinx
errors and make it our own.

Change-Id: I2996b793f6ef5881749a9fc3b7ce7d202a6a1349
2014-04-17 12:44:19 -05:00
Alex Gaynor f35a8e1861 Several stylistic fixes for the docs
Change-Id: I61a1c37be2fd343a0c5021233fcbbd5454215439
2014-03-14 15:48:45 -07:00
Jesse Noller e0418241a3 setting up the initial layout; move the api proposals to api_strawman
Change-Id: I7c933d5e023c2a98a64aa90ed209f1e25d07f0d9
2014-01-24 22:58:25 -06:00
EdLeafe 73c11a1fb4 Added example code based on pystack. 2014-01-21 17:08:07 -06:00
Alex Gaynor fa65e373bc This should be a plural 2014-01-21 13:57:16 -06:00
Alex Gaynor 92377e828d Consolidate readmes 2014-01-21 13:56:42 -06:00
Alex Gaynor 2d25080a03 Initial blob of thoughts from me 2014-01-21 13:55:49 -06:00