Skip to content

Commit d2402eb

Browse files
MarkDaoustmarkmcdshilpakancharlaPetchean Ang
committed
First commit: Push everyone's code.
Co-authored-by: Mark McDonald <[email protected]> Co-authored-by: Shilpa Kancharla <[email protected]> Co-authored-by: Petchean Ang <[email protected]>
0 parents  commit d2402eb

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

79 files changed

+11080
-0
lines changed

‎.gitignore

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
/venv/
2+
/.eggs/
3+
/.idea/
4+
/.pytype/
5+
/build/
6+
/docs/api
7+
*.egg-info
8+
.DS_Store
9+
__pycache__

‎CODE_OF_CONDUCT.md

+94
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
<!-- # Generated by synthtool. DO NOT EDIT! !-->
2+
# Code of Conduct
3+
4+
## Our Pledge
5+
6+
In the interest of fostering an open and welcoming environment, we as
7+
contributors and maintainers pledge to making participation in our project and
8+
our community a harassment-free experience for everyone, regardless of age, body
9+
size, disability, ethnicity, gender identity and expression, level of
10+
experience, education, socio-economic status, nationality, personal appearance,
11+
race, religion, or sexual identity and orientation.
12+
13+
## Our Standards
14+
15+
Examples of behavior that contributes to creating a positive environment
16+
include:
17+
18+
* Using welcoming and inclusive language
19+
* Being respectful of differing viewpoints and experiences
20+
* Gracefully accepting constructive criticism
21+
* Focusing on what is best for the community
22+
* Showing empathy towards other community members
23+
24+
Examples of unacceptable behavior by participants include:
25+
26+
* The use of sexualized language or imagery and unwelcome sexual attention or
27+
advances
28+
* Trolling, insulting/derogatory comments, and personal or political attacks
29+
* Public or private harassment
30+
* Publishing others' private information, such as a physical or electronic
31+
address, without explicit permission
32+
* Other conduct which could reasonably be considered inappropriate in a
33+
professional setting
34+
35+
## Our Responsibilities
36+
37+
Project maintainers are responsible for clarifying the standards of acceptable
38+
behavior and are expected to take appropriate and fair corrective action in
39+
response to any instances of unacceptable behavior.
40+
41+
Project maintainers have the right and responsibility to remove, edit, or reject
42+
comments, commits, code, wiki edits, issues, and other contributions that are
43+
not aligned to this Code of Conduct, or to ban temporarily or permanently any
44+
contributor for other behaviors that they deem inappropriate, threatening,
45+
offensive, or harmful.
46+
47+
## Scope
48+
49+
This Code of Conduct applies both within project spaces and in public spaces
50+
when an individual is representing the project or its community. Examples of
51+
representing a project or community include using an official project e-mail
52+
address, posting via an official social media account, or acting as an appointed
53+
representative at an online or offline event. Representation of a project may be
54+
further defined and clarified by project maintainers.
55+
56+
This Code of Conduct also applies outside the project spaces when the Project
57+
Steward has a reasonable belief that an individual's behavior may have a
58+
negative impact on the project or its community.
59+
60+
## Conflict Resolution
61+
62+
We do not believe that all conflict is bad; healthy debate and disagreement
63+
often yield positive results. However, it is never okay to be disrespectful or
64+
to engage in behavior that violates the project’s code of conduct.
65+
66+
If you see someone violating the code of conduct, you are encouraged to address
67+
the behavior directly with those involved. Many issues can be resolved quickly
68+
and easily, and this gives people more control over the outcome of their
69+
dispute. If you are unable to resolve the matter for any reason, or if the
70+
behavior is threatening or harassing, report it. We are dedicated to providing
71+
an environment where participants feel welcome and safe.
72+
73+
Reports should be directed to *[email protected]*, the
74+
Project Steward(s) for *Google Cloud Client Libraries*. It is the Project Steward’s duty to
75+
receive and address reported violations of the code of conduct. They will then
76+
work with a committee consisting of representatives from the Open Source
77+
Programs Office and the Google Open Source Strategy team. If for any reason you
78+
are uncomfortable reaching out to the Project Steward, please email
79+
[email protected].
80+
81+
We will investigate every complaint, but you may not receive a direct response.
82+
We will use our discretion in determining when and how to follow up on reported
83+
incidents, which may range from not taking action to permanent expulsion from
84+
the project and project-sponsored spaces. We will notify the accused of the
85+
report and provide them an opportunity to discuss it before any action is taken.
86+
The identity of the reporter will be omitted from the details of the report
87+
supplied to the accused. In potentially harmful situations, such as ongoing
88+
harassment or threats to anyone's safety, we may take action without notice.
89+
90+
## Attribution
91+
92+
This Code of Conduct is adapted from the Contributor Covenant, version 1.4,
93+
available at
94+
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

‎CONTRIBUTING.md

+106
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
# How to become a contributor and submit your own code
2+
3+
**Table of contents**
4+
5+
* [Contributor License Agreements](#contributor-license-agreements)
6+
* [Contributing a patch](#contributing-a-patch)
7+
* [Running the tests](#running-the-tests)
8+
* [Releasing the library](#releasing-the-library)
9+
10+
## Contributor License Agreements
11+
12+
We'd love to accept your sample apps and patches! Before we can take them, we
13+
have to jump a couple of legal hurdles.
14+
15+
Please fill out either the individual or corporate Contributor License Agreement
16+
(CLA).
17+
18+
* If you are an individual writing original source code and you're sure you
19+
own the intellectual property, then you'll need to sign an [individual CLA](https://developers.google.com/open-source/cla/individual).
20+
* If you work for a company that wants to allow you to contribute your work,
21+
then you'll need to sign a [corporate CLA](https://developers.google.com/open-source/cla/corporate).
22+
23+
Follow either of the two links above to access the appropriate CLA and
24+
instructions for how to sign and return it. Once we receive it, we'll be able to
25+
accept your pull requests.
26+
27+
## Contributing A Patch
28+
29+
1. Submit an issue describing your proposed change to the repo in question.
30+
1. The repo owner will respond to your issue promptly.
31+
1. If your proposed change is accepted, and you haven't already done so, sign a
32+
Contributor License Agreement (see details above).
33+
1. Fork the desired repo, develop and test your code changes.
34+
1. Ensure that your code adheres to the existing style in the code to which
35+
you are contributing.
36+
1. Ensure that your code has an appropriate set of tests which all pass.
37+
1. Title your pull request following [Conventional Commits](https://www.conventionalcommits.org/) styling.
38+
1. Submit a pull request.
39+
40+
### Before you begin
41+
42+
1. [Select or create a Cloud Platform project][projects].
43+
1. [Enable billing for your project][billing].
44+
1. [Enable the Generative Language API][enable_api].
45+
1. [Set up authentication with a service account][auth] so you can access the
46+
API from your local workstation.
47+
48+
You can use an API-key, but remember never to same it in your source files.
49+
50+
51+
## Development
52+
53+
### Local install
54+
55+
Install the source in "editable" mode, with testing requirements:
56+
57+
```
58+
pip install -e .[dev]
59+
```
60+
61+
This "editable" mode lets you edit the source without needing to reinstall the package.
62+
63+
### Testing
64+
65+
Use the builtin unittest package:
66+
67+
```
68+
python -m unittest
69+
```
70+
71+
Or to debug, use:
72+
73+
```commandline
74+
nose2 --debugger
75+
```
76+
77+
### Type checking
78+
79+
Use `pytype` (configured in `pyproject.toml`)
80+
81+
```
82+
pip install pytype
83+
pytype
84+
```
85+
86+
### Formatting:
87+
88+
Use black:
89+
90+
```
91+
pip install black
92+
black .
93+
```
94+
95+
### Generate api reference
96+
97+
```
98+
python docs/build_docs.py
99+
```
100+
101+
102+
[setup]: https://cloud.google.com/nodejs/docs/setup
103+
[projects]: https://console.cloud.google.com/project
104+
[billing]: https://support.google.com/cloud/answer/6293499#enable-billing
105+
[enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=generativelanguage.googleapis.com
106+
[auth]: https://cloud.google.com/docs/authentication/getting-started

0 commit comments

Comments
 (0)