Skip to content

Commit

Permalink
Merge pull request #5 from sailpoint-oss/release/cleanup
Browse files Browse the repository at this point in the history
Update auth to use form parameters and cleanup repo to be ready for r…
  • Loading branch information
tyler-mairose-sp authored Feb 13, 2024
2 parents 81318f6 + 1c52c64 commit 7112753
Show file tree
Hide file tree
Showing 11 changed files with 337 additions and 832 deletions.
36 changes: 36 additions & 0 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: Release

on:
release:
types: [created]

jobs:
pypi-publish:
name: upload release to PyPI
runs-on: ubuntu-latest
environment: release
permissions:
id-token: write
steps:
- name: Checkout branch
uses: actions/checkout@v3
with:
ref: ${{ github.ref }}

- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.x'
- name: Install build package
id: requirements
run: |
python -m pip install --upgrade build
- name: Build test package
id: build
if: steps.requirements.outcome == 'success'
run: |
python -m build
- name: Publish package distributions to PyPI
uses: pypa/gh-action-pypi-publish@release/v1
79 changes: 79 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# Contributor Covenant Code of Conduct

## Our Pledge

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 a positive environment for our community include:

- 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 include:

- 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 email address, without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting

## Enforcement Responsibilities

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.

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 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 to the community leaders responsible for enforcement at https://developer.sailpoint.com/discuss/c/feedback/. 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.

**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 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
146 changes: 146 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
# Contribute to the SailPoint Python SDK

The SailPoint Developer Relations Team is always actively working to improve the SailPoint Python SDK to make it as useful as possible to the SailPoint Developer Community.
This means adding and maintaining new resources and functionalities for the SDK.
The most valuable resource of all, however, is the community itself!
We greatly appreciate any input, feedback, and direct contributions you can provide to the Python SDK, big or small.
And we want to make the process of contributing to this project as easy and transparent as possible.

This document will detail the different ways that you can contribute to the community.

These are the main ways that you can contribute:
- [Report issues](#report-issues)
- [Request new features](#request-new-features)
- [Submit a fix](#submit-a-fix)
- [Submit a new feature](#submit-a-new-feature)

## How we use GitHub

We use GitHub to host code, track issues and feature requests, and manage contributions with pull requests.

This project is open source, which means that it's publicly accessible, allowing anyone who comes across it to view, share, and improve its source code.

## GitHub flow and pull requests

The best way to propose changes to the codebase is to use pull requests, and [Github Flow](https://docs.github.com/en/get-started/quickstart/github-flow) is our preferred method of accepting pull requests.

This is the basic GitHub flow we use for direct contributions to the codebase:

1. Fork the repository and create your own branch from `main`.
2. Make your changes in your `main` branch.
3. Push the changes to the repository's `main` branch.
4. Create your pull request!
5. SailPoint Developer Relations team members will review your pull request and merge it in!

## GitHub Issues

We use [GitHub Issues](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues) to publicly track bugs and feature requests.

## Report issues

You may encounter bugs and incorrect or outdated information when you explore the Python SDK.
We appreciate your help in identifying bugs of all sizes, from broken links or typos to major issues preventing you from using a resource.

We use GitHub issues to track bugs publicly. If you see an issue with the SDK, please [report it here](https://github.com/sailpoint-oss/python-sdk/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here).

We love thorough bug reports.
The more details you include, the faster we can troubleshoot and fix the issue.
Great bug reports include these details:

1. A summary of the issue
2. The steps we can take to reproduce the issue
- Be as specific as you can when you describe these steps.
- Give us sample code if you can.
3. What you expect to happen
4. What actually happens
5. Screenshots
6. The operating system you were using when you encountered the issue
7. The browser you were using when you encountered the issue
8. Notes
- If you have an idea, tell us why you think the issue may be occurring, or what you think we should do to resolve it.
- Whatever you tried that didn't work.
- Anything else you think might be useful to us.

## Request new features

Many of our most valuable resources originate in ideas suggested by the community!
You may have an idea that will improve the site.
We would love to hear it and possibly implement it!

We use GitHub issues to track feature requests. Please use [this template](https://github.com/sailpoint-oss/typescript-sdk/issues/new?assignees=&labels=&template=feature-request.md&title=%5BFeature%5D+Your+Feature+Request+Here) when you request a new feature.

We love thorough feature requests.
The more details you include, the faster we can implement your request.
Great feature requests include these details:

1. Tell us whether this feature is related to a problem.
- If it is, describe the problem.
2. Describe your desired solution.
3. Describe alternative solutions you may use yourself or other solutions you may have considered.
4. Notes
- If possible, include how you think this solution would benefit others.
- Anything else you think might be useful to us.

## Submit a fix

One of the main benefits of making our project open source is that it makes it possible for the community to contribute to the Python SDK directly.
We will always respond as quickly as we can to any issues you report, but if you know how to fix an issue, the fastest way to get it fixed is to submit a pull request and make the fix yourself!
If you can do this, it's tremendously helpful to us in our efforts to improve the community, and, if you're interested, you will receive ambassador points for your fix.
Check out the [ambassador program](https://developer.sailpoint.com/discuss/t/getting-started-as-a-developer-community-ambassador/11665) to learn more.

To submit a fix, follow these steps:
1. Fork the repository and copy the `main` branch.
2. Pull the latest code and ensure that it's running properly.
3. Create a new branch from main.
- Follow this naming convention for your branch: `fix/your-fix-name`
4. Create a pull request from your branch to our origin repository's `main` branch!

Once you create the pull request, the SailPoint Developer Relations Team will be tagged.
Someone will then review the pull request and merge it in!

>Some files in the Python SDK are auto-generated, so you cannot directly make changes to them (your changes would be overwritten).
These are the auto-generated files (found within the 'sailpoint' folder) you cannot modify:
>- The 'beta' folder containing the Beta API specifications
>- The 'v3' folder containing the V3 API specifications
## Submit a new feature

We will always respond to your feature requests and implement them as soon as we can.
However, if you have an idea for a new feature and know how to implement it yourself, the fastest way to add the feature is to submit a pull request and add the feature yourself!
If you can do this, we greatly appreciate it, and other community members will benefit from your contribution!
And if you're interested, you will receive ambassador points for your feature contribution.
Check out the [ambassador program](https://developer.sailpoint.com/discuss/t/getting-started-as-a-developer-community-ambassador/11665) to learn more.

To submit a new feature, follow these steps:
1. Fork the repository and copy the `main` branch.
2. Pull the latest code and ensure that it's running properly.
3. Create a new branch from main.
- Follow this naming convention for your branch: `feature/your-feature-name`
4. Create a pull request from your branch to our origin repository's `main` branch!

Once you create the pull request, the SailPoint Developer Relations Team will be tagged.
Someone will then review the pull request and merge it in!

>Some files in the Python SDK are auto-generated, so you cannot directly make changes to them (your changes would be overwritten).
These are the auto-generated files (found within the 'sailpoint' folder) you cannot modify:
>- The 'beta' folder containing the Beta API specifications
>- The 'v3' folder containing the V3 API specifications
## Report general issues

It's possible that none of the options listed here will properly address your issue.
If you have a general issue, you can submit a general issue by using GitHub's [issues](https://github.com/sailpoint-oss/python-sdk/issues).
Add as much detail as you can to your issue, and we will address it as quickly as we can.

## Discuss on the forum

What makes the SailPoint Developer Community great is its brilliant, knowledgeable members!
If you have a question, problem, or idea, one of the best ways to get answers or resolutions is to go to the [Developer Community Forum](https://developer.sailpoint.com/discuss) to discuss them directly with the community on the forum.
The SailPoint Developer Relations Team, the community ambassadors, and other members will be there to discuss them with you.
And once you're there, you can help others on the forum too!
If you're interested, you will receive ambassador points for the issues you help others resolve on the forum. Check out the [ambassador program](https://developer.sailpoint.com/discuss/t/getting-started-as-a-developer-community-ambassador/11665) to learn more.

## MIT Software License

This project uses the [MIT License](http://choosealicense.com/licenses/mit/).
Whenever you submit code changes, your submissions are held under the same MIT license that covers the project.
21 changes: 21 additions & 0 deletions License
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2022 SailPoint Technologies Holdings, Inc

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.
29 changes: 26 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Python SailPoint SDK

[![Discourse Topics][discourse-shield]][discourse-url]
![Times Downloaded][downloads-shield] ![Issues][issues-shield]
![Latest Releases][release-shield] ![Contributor Shield][contributor-shield]
Expand All @@ -11,8 +13,29 @@
[contributor-shield]: https://img.shields.io/github/contributors/sailpoint-oss/python-sdk?label=Contributors
[license-shield]: https://img.shields.io/badge/MIT-License-green

Documentation
## About the project

The Python SDK allows you to use TypeScript to interact with the SailPoint APIs and other resources to customize and extend your SailPoint platform.

## Documentation

To get started with the Python SDK and learn about its various functionalities, refer to the [documentation](https://developer.sailpoint.com/idn/tools/sdk/python) on <https://developer.sailpoint.com>.

## Contributing

The SailPoint Developer Relations Team is always actively working to improve the SailPoint TypeScript SDK to make it as useful as possible to the SailPoint Developer Community.
This means adding and maintaining new resources and functionalities for the SDK.
The most valuable resource of all, however, is the community itself!
We greatly appreciate any input, feedback, and direct contributions you can provide to the TypeScript SDK, big or small.

Refer to our [contribution guidelines](./CONTRIBUTING.md) to learn more about the different ways you can contribute to the SDK.

Before you contribute, you [must sign our CLA](https://cla-assistant.io/sailpoint-oss/developer.sailpoint.com).

## License

Distributed under the MIT License. Refer to [the license](./LICENSE) for more information.

The SailPoint SDK is an API Client that provides programmable access to the SailPoint Identity Now APIs through various languages.
## Code of Conduct

For documentation, please see https://developer.sailpoint.com/idn/tools/sdk/python
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. Read our [code of conduct](./CODE_OF_CONDUCT.md) to learn more.
2 changes: 2 additions & 0 deletions example.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@
print(account.name)


with sailpoint.beta.ApiClient(configuration) as api_client:

workgroups = sailpoint.beta.GovernanceGroupsApi(api_client).list_workgroups()
for workgroup in workgroups:
print(workgroup.name)
Loading

0 comments on commit 7112753

Please sign in to comment.