Skip to content

Latest commit

 

History

History
232 lines (179 loc) · 10.8 KB

CONTRIBUTING_python.md

File metadata and controls

232 lines (179 loc) · 10.8 KB
Raw

Contributing

This file provides general guidance for anyone contributing to IBM Cloud Python SDK projects produced by the IBM OpenAPI SDK Generator.

Table of Contents

Questions

If you are having problems using the APIs or have a question about IBM Cloud services, please ask a question at Stack Overflow.

Coding Style

This SDK follows a coding style based on the PEP8 Style Guide for Python, with the following modifications:

  • four spaces instead of tabs for indentation

All non-trivial methods should have docstrings. Docstrings should follow the PEP257 guidelines. For more examples, see the Google style guide regarding docstrings.

Use PyLint to adhere to these guidelines.

Commit Messages

Commit messages should follow the Angular Commit Message Guidelines. This is because our release tool - semantic-release - uses this format for determining release versions and generating changelogs. Tools such as commitizen or commitlint can be used to help contributors and enforce commit messages.

Here are some examples of acceptable commit messages, along with the release type that would be done based on the commit message:

Commit message Release type
fix(example service): fix integration test to use correct credentials Patch Release
feat(global catalog): add global-catalog service to project Minor Feature Release
feat(global search): re-gen service code with new v3 API definition

BREAKING CHANGE: The global-search service has been updated to reflect version 3 of the API.		 Major Breaking Release

Pull Requests

If you want to contribute to the repository, here's a quick guide:

  1. Fork the repository and clone your fork to your local environment
  2. (recommended) Install and activate a virtual environment:
    • python -m venv <venv-dir>, where <venv-dir> indicates where to install the virtual environment
    • . <venv-dir>/bin/activate
  3. Install the project as an editable package using the current source:
    • python -m pip install -e .
  4. Install dependencies:
    • python -m pip install -r requirements.txt
    • python -m pip install -r requirements-dev.txt
  5. Develop and test your code changes:
    • Please add one or more tests to validate your changes.
    • To run all the tests: python -m pytest
    • You can find more details about running the tests below.
  6. Check and fix code style: ./pylint.sh
  7. Make sure everything builds/tests cleanly
  8. Commit your changes
    • Make sure your commit messages follow the Angular Commit Message Guidelines (see below).
  9. Push to your fork and submit a pull request to the main branch

Adding a new service

This section will guide you through the steps to generate the Python code for a service and add the generated code to your SDK project.

  1. Validate the API definition - before trying to process the API definition with the SDK generator, we strongly recommend that you validate the API definition with the IBM OpenAPI Validator . Example:
lint-openapi -s example-service.yaml

This command will display a list of errors and warnings found in the API definition as well as a summary at the end. It's not required that you fix all errors and warnings before trying to use the SDK generator, but this step should identify any critical errors that will need to be fixed prior to the generation step.

  1. Recommended: Modify your API definition to configure the apiPackage property. The value of this property should be the project's python package name (e.g. ibm_platform_services). Here's an example:
  info:
    x-codegen-config:
      python:
        apiPackage: 'ibm_platform_services'

By adding this configuration property to your API definition, you can avoid using the --api-package command line option when running the SDK generator.

More details about SDK generator configuration properties can be found here.

  1. Next, run the SDK generator to process your API definition and generate the service and unit test code for the service.

You'll find instructions on how to install and run the SDK generator on the generator repository wiki.

Set the output location for the generated files to be the root directory of the project.

If you did not configure the apiPackage configuration property in your API definition file(s), then be sure to use the --api-package <package> command line option when running the SDK generator to ensure that source files are generated correctly for your project.

Here is an example of how to generate the Python code for an API definition. Suppose your API definition file is named my-service.json and contains the definition of the "My Service" service. To generate the code into your project, run these commands:

cd <project-root>

openapi-sdkgen.sh generate -g ibm-python -i my-service.json -o . --api-package <package>

The generated service code is written to the <package> directory, and the unit test code is written to test/unit.

Hint: you can generate an initial integration test for your service by including the --genITs option when running the SDK generator. This will generate an integration test in the test/integration directory. It is expected that the generated integration test is a starting point which will need manual editing to form an effective integration test for the service.

  1. Update <package>/__init__.py to add an import statement for the newly-generated service, like this:
from .my_service_v1 import MyServiceV1

  1. Update the service table in the README.md file to add an entry for the new service.

  2. Repeat the steps in this section for each service to be included in your project.

Running the Tests

To run all of the tests (both unit and integration tests):

  • python -m pytest

Note that integration tests require credentials - see below.

You can run a specific test like this:

  • python -m pytest <path-to-test>/mytest.py

Unit tests

Unit tests use a mock service endpoint, so they do not need any credentials. To run the unit tests:

  • python -m pytest test/unit

Integration tests

Integration tests use an actual service endpoint, so you need to provide credentials to the integration test framework.

The integration test framework will skip integration tests for any service that does not have credentials.

To provide credentials for the integration tests, store the credentials as properties within a .env file.

To run only the integration tests:

  • python -m pytest test/integration To run only a specific integration test:
  • python -m pytest test/integration/test_example_service_v1.py

Code Coverage

This project uses coverage to measure code coverage. To obtain a code coverage report, run coverage run from the root of the project, and then view the coverage report from the coverage report command.

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or

(b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or

(c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.

(d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.

Additional Resources