Merge pull request #61 from merative/rebrand

Rebrand

Author: dlangst

.bumpversion.cfg

@@ -3,7 +3,7 @@ current_version = 1.11.6
 commit = True
 message = Update version {current_version} -> {new_version}
 
-[bumpversion:file:ibm_whcs_sdk/version.py]
+[bumpversion:file:acd_sdk/version.py]
 search = __version__ = '{current_version}'
 replace = __version__ = '{new_version}'
 

CODE_OF_CONDUCT.md

@@ -2,75 +2,128 @@
 
 ## Our Pledge
 
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, sex characteristics, gender identity and expression,
-level of experience, education, socio-economic status, nationality, personal
-appearance, race, religion, or sexual identity and orientation.
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
 
 ## Our Standards
 
-Examples of behavior that contributes to creating a positive environment
-include:
+Examples of behavior that contributes to a positive environment for our
+community include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
 
-Examples of unacceptable behavior by participants include:
+Examples of unacceptable behavior include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
- advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
 * Public or private harassment
-* Publishing others' private information, such as a physical or electronic
- address, without explicit permission
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
 * Other conduct which could reasonably be considered inappropriate in a
- professional setting
+  professional setting
 
-## Our Responsibilities
+## Enforcement Responsibilities
 
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
 
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
 
 ## Scope
 
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
 
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at phil_adams@us.ibm.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
+reported to the community leaders responsible for enforcement via an [issue](https://github.com/merative/acd-python-sdk/issues).
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
 
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
 
-[homepage]: https://www.contributor-covenant.org
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
 
-For answers to common questions about this code of conduct, see
-https://www.contributor-covenant.org/faq
+For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ].
+Translations are available at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

@@ -4,14 +4,164 @@ If you are having problems using the SDK or have a question about the Annotator
 refer here:
 * [README](README.md)
 * [Annotator for Clinical Data documentation](https://merative.github.io/acd-containers/)
-* [Annotator for Clinical Data product site](https://www.ibm.com/cloud/watson-annotator-for-clinical-data)
+* [Annotator for Clinical Data Support page](https://merative.github.io/acd-containers/support/support/)
 
 # Issues
 
-If you encounter an issue with the Python Core SDK, you are welcome to submit a 
+If you encounter an issue with the project, you are welcome to submit a 
 [bug report](https://github.com/merative/whcs-python-sdk/issues).
 
-# General Information
-i
-For general guidance on contributing to this project, please see
-[this link](https://github.com/IBM/ibm-cloud-sdk-common/blob/master/CONTRIBUTING_python.md)
+# Contributing in General
+
+Our project welcomes external contributions.
+
+To contribute code or documentation, please submit a [pull request](https://github.com/merative/acd-python-sdk/pulls).
+
+A good way to familiarize yourself with the codebase and contribution process is
+to look for and tackle low-hanging fruit in the [issue tracker](https://github.com/merative/acd-python-sdk/issues).
+Before embarking on a more ambitious contribution, please reach out to acddev@merative.com.
+
+**Note: We appreciate your effort, and want to avoid a situation where a contribution
+requires extensive rework (by you or by us), sits in backlog for a long time, or
+cannot be accepted at all!**
+
+## Proposing new features
+
+If you would like to implement a new feature, please [raise an issue](https://github.com/merative/acd-python-sdk/issues)
+before sending a pull request so the feature can be discussed. This is to avoid
+you wasting your valuable time working on a feature that the project developers
+are not interested in accepting into the code base.
+
+## Fixing bugs
+
+If you would like to fix a bug, please [raise an issue](https://github.com/merative/acd-python-sdk/issues) before sending a
+pull request so it can be tracked.
+
+## Coding style
+
+This SDK follows a coding style based on the [PEP8 Style Guide for Python](https://www.python.org/dev/peps/pep-0008/),
+with the following modifications:
+- four spaces instead of tabs for indentation
+
+All non-trivial methods should have docstrings.
+Docstrings should follow the [PEP257 guidelines](https://www.python.org/dev/peps/pep-0257/).
+For more examples, see the [Google style guide](https://google.github.io/styleguide/pyguide.html#381-docstrings)
+regarding docstrings.
+
+Use [PyLint](https://www.pylint.org/) to adhere to these guidelines.
+
+## Commit messages
+
+Commit messages should follow the [Angular Commit Message Guidelines](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-guidelines).
+This is because our release tool - [semantic-release](https://github.com/semantic-release/semantic-release) -
+uses this format for determining release versions and generating changelogs.
+Tools such as [commitizen](https://github.com/commitizen/cz-cli) or [commitlint](https://github.com/conventional-changelog/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(<optional scope>): <fix message details>`                                                                                                 | ~~Patch~~ Fix Release      |
+| `feat(<optional scope>): <feature message details>`                                                                                            | ~~Minor~~ Feature Release  |
+| `feat(<optional scope>): <feature message details>`<br><br>`BREAKING CHANGE: <message details>`                                                | ~~Major~~ Breaking Release <br/> (Note that the `BREAKING CHANGE: ` token must be in the footer of the commit) |
+
+## 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](https://docs.python.org/3/tutorial/venv.html):
+     * `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
+
+## 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.
+
+To run only the integration tests:
+* `python -m pytest test/integration`
+
+To provide credentials for the integration tests, add credentials to your ACD Python SDK installation's <your_install_path>/acd-sdk/annotator_for_clinical_data/tests/config.ini file.  Configure your credentials based on your Anotator for Clinical Data service authentication method.
+
+If using IAM authentication:
+
+```
+[settings]
+base_url = <your ACD endpoint URL>
+key = <your ACD endpoint API key>
+iam_url = <optional>
+version = <ACD API version YYYY-MM-DD>
+bearer_token =
+disable_ssl = <True or False (False is recommended)>
+flow = <optional name of ACD flow persisted to your ACD endpoint>
+profile = <optional name of ACD profile persisted to your ACD endpoint>
+```
+
+If using Bearer Token authentication:
+
+```
+[settings] 
+base_url = <your ACD endpoint URL> 
+key =
+iam_url =
+bearer_token = <your ACD endpoint bearer token>
+version = <ACD API version YYYY-MM-DD>
+disable_ssl = <True or False (False is recommended)>
+flow = <optional name of ACD flow persisted to your ACD endpoint>
+profile = <optional name of ACD profile persisted to your ACD endpoint>
+```
+
+## 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.

Makefile

@@ -23,10 +23,10 @@ install_project:
 test: test-unit test-int
 
 test-unit:
-	python -m pytest ibm-whcs-sdk/annotator-for-clinical-data/tests/unit
+	python -m pytest acd_sdk/annotator_for_clinical_data/tests/unit
 
 test-int:
-	python -m pytest ibm-whcs-sdk/annotator-for-clinical-data/tests/integration
+	python -m pytest acd_sdk/annotator_for_clinical_data/tests/integration
 
 lint:
 	./pylint.sh