Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: v2.18.4 のドキュメントに更新 #1

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .coveragerc
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[run]
omit = requests/packages/*
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
Summary.

## Expected Result

What you expected.

## Actual Result

What happened instead.

## Reproduction Steps

```python
import requests

```

## System Information

$ python -m requests.help

```
<paste here>
```

This command is only available on Requests v2.16.4 and greater. Otherwise,
please provide some basic information about your system (Python version,
operating system, &c).
6 changes: 3 additions & 3 deletions .gitignore
100644 → 100755
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@ nosetests.xml
junit-report.xml
pylint.txt
toy.py
tox.ini
violations.pyflakes.txt
.cache/
cover/
build/
docs/_build
Expand All @@ -20,4 +19,5 @@ env/

t.py

t2.py
t2.py
dist
31 changes: 31 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
sudo: false
language: python
python:
- "2.6"
- "2.7"
- "3.4"
- "3.5"
- "3.6"
# - "3.7-dev"
# - "pypy" -- appears to hang
# - "pypy3"
# command to install dependencies
install: "make"
# command to run tests
script:
- |
if [[ "$TRAVIS_PYTHON_VERSION" != "2.6" ]] ; then make test-readme; fi
- make ci
cache: pip
jobs:
include:
- stage: test
script:
- |
if [[ "$TRAVIS_PYTHON_VERSION" != "2.6" ]] ; then make test-readme; fi
- make ci
- stage: coverage
python: 3.6
script: codecov


121 changes: 83 additions & 38 deletions AUTHORS.rst
Original file line number Diff line number Diff line change
@@ -1,29 +1,30 @@
.. Requests is written and maintained by Kenneth Reitz and
various contributors:

Requestsは、Kenneth Reitzやたくさんのコントリビューターによって書かれていて、メンテナンスされています。
Requests は、Kenneth Reitz とたくさんのコントリビューターによって書かれていて、
メンテナンスされています。

.. Development Lead
````````````````
.. Keepers of the Four Crystals
````````````````````````````

メイン開発者
```````````````````
四つのクリスタルを守る者
````````````````````````````

- Kenneth Reitz <[email protected]>


Urllib3
```````

- Andrey Petrov <[email protected]>
.. Kenneth Reitz <[email protected]> `@kennethreitz <https://github.com/kennethreitz>`_, Keeper of the Master Crystal.
.. Cory Benfield <[email protected]> `@lukasa <https://github.com/lukasa>`_
.. Ian Cordasco <[email protected]> `@sigmavirus24 <https://github.com/sigmavirus24>`_
.. Nate Prewitt <[email protected]> `@nateprewitt <https://github.com/nateprewitt>`_

- Kenneth Reitz <[email protected]> `@kennethreitz <https://github.com/kennethreitz>`_、マスタークリスタルのキーパー。
- Cory Benfield <[email protected]> `@lukasa <https://github.com/lukasa>`_
- Ian Cordasco <[email protected]> `@sigmavirus24 <https://github.com/sigmavirus24>`_
- Nate Prewitt <[email protected]> `@nateprewitt <https://github.com/nateprewitt>`_

.. Patches and Suggestions
```````````````````````


パッチと提案
``````````````````````````
```````````````````````

- Various Pocoo Members
- Chris Adams
Expand All @@ -48,7 +49,7 @@ Urllib3
- Peter Manser
- Jeremy Selier
- Jens Diemer
- Alex <@alopatin>
- Alex (`@alopatin <https://github.com/alopatin>`_)
- Tom Hogans <[email protected]>
- Armin Ronacher
- Shrikant Sharat Kandula
Expand Down Expand Up @@ -85,11 +86,10 @@ Urllib3
- Chase Sterling
- Marty Alchin
- takluyver
- Ben Toews (mastahyeti)
- Ben Toews (`@mastahyeti <https://github.com/mastahyeti>`_)
- David Kemp
- Brendon Crawford
- Denis (Telofy)
- Cory Benfield (Lukasa)
- Denis (`@Telofy <https://github.com/Telofy>`_)
- Matt Giuca
- Adam Tauber
- Honza Javorek
Expand All @@ -106,43 +106,88 @@ Urllib3
- Jonty Wareing <[email protected]>
- Shivaram Lingamneni
- Miguel Turner
- Rohan Jain (crodjer)
- Rohan Jain (`@crodjer <https://github.com/crodjer>`_)
- Justin Barber <[email protected]>
- Roman Haritonov <@reclosedev>
- Roman Haritonov (`@reclosedev <https://github.com/reclosedev>`_)
- Josh Imhoff <[email protected]>
- Arup Malakar <[email protected]>
- Danilo Bargen (dbrgn)
- Danilo Bargen (`@dbrgn <https://github.com/dbrgn>`_)
- Torsten Landschoff
- Michael Holler (apotheos)
- Michael Holler (`@apotheos <https://github.com/apotheos>`_)
- Timnit Gebru
- Sarah Gonzalez
- Victoria Mo
- Leila Muhtasib
- Matthias Rahlf <[email protected]>
- Jakub Roztocil <[email protected]>
- Ian Cordasco <[email protected]> @sigmavirus24
- Rhys Elsmore
- André Graf (dergraf)
- Stephen Zhuang (everbird)
- André Graf (`@dergraf <https://github.com/dergraf>`_)
- Stephen Zhuang (`@everbird <https://github.com/everbird>`_)
- Martijn Pieters
- Jonatan Heyman
- David Bonner <[email protected]> @rascalking
- David Bonner <[email protected]> (`@rascalking <https://github.com/rascalking>`_)
- Vinod Chandru
- Johnny Goodnow <[email protected]>
- Denis Ryzhkov <[email protected]>
- Wilfred Hughes <[email protected]> @dontYetKnow
- Wilfred Hughes <[email protected]>
- Dmitry Medvinsky <[email protected]>
- Bryce Boe <[email protected]> @bboe
- Colin Dunklau <[email protected]> @cdunklau
- Bob Carroll <[email protected]> @rcarz
- Hugo Osvaldo Barrera <[email protected]> @hobarrera
- Łukasz Langa <[email protected]> @llanga
- Bryce Boe <[email protected]> (`@bboe <https://github.com/bboe>`_)
- Colin Dunklau <[email protected]> (`@cdunklau <https://github.com/cdunklau>`_)
- Bob Carroll <[email protected]> (`@rcarz <https://github.com/rcarz>`_)
- Hugo Osvaldo Barrera <[email protected]> (`@hobarrera <https://github.com/hobarrera>`_)
- Łukasz Langa <[email protected]>
- Dave Shawley <[email protected]>
- James Clarke (jam)
- James Clarke (`@jam <https://github.com/jam>`_)
- Kevin Burke <[email protected]>
- Flavio Curella
- David Pursehouse <[email protected]> @dpursehouse
- Jon Parise
- Alexander Karpinsky @homm86
- Marc Schlaich @schlamar
- Park Ilsu <[email protected]> @daftshady
- David Pursehouse <[email protected]> (`@dpursehouse <https://github.com/dpursehouse>`_)
- Jon Parise (`@jparise <https://github.com/jparise>`_)
- Alexander Karpinsky (`@homm86 <https://twitter.com/homm86>`_)
- Marc Schlaich (`@schlamar <https://github.com/schlamar>`_)
- Park Ilsu <[email protected]> (`@daftshady <https://github.com/daftshady>`_)
- Matt Spitz (`@mattspitz <https://github.com/mattspitz>`_)
- Vikram Oberoi (`@voberoi <https://github.com/voberoi>`_)
- Can Ibanoglu <[email protected]> (`@canibanoglu <https://github.com/canibanoglu>`_)
- Thomas Weißschuh <[email protected]> (`@t-8ch <https://github.com/t-8ch>`_)
- Jayson Vantuyl <[email protected]>
- Pengfei.X <[email protected]>
- Kamil Madac <[email protected]>
- Michael Becker <[email protected]> (`@beckerfuffle <https://twitter.com/beckerfuffle>`_)
- Erik Wickstrom <[email protected]> (`@erikwickstrom <https://github.com/erikwickstrom>`_)
- Константин Подшумок (`@podshumok <https://github.com/podshumok>`_)
- Ben Bass (`@codedstructure <https://github.com/codedstructure>`_)
- Jonathan Wong <[email protected]> (`@ContinuousFunction <https://github.com/ContinuousFunction>`_)
- Martin Jul (`@mjul <https://github.com/mjul>`_)
- Joe Alcorn (`@buttscicles <https://github.com/buttscicles>`_)
- Syed Suhail Ahmed <[email protected]> (`@syedsuhail <https://github.com/syedsuhail>`_)
- Scott Sadler (`@ssadler <https://github.com/ssadler>`_)
- Arthur Darcet (`@arthurdarcet <https://github.com/arthurdarcet>`_)
- Ulrich Petri (`@ulope <https://github.com/ulope>`_)
- Muhammad Yasoob Ullah Khalid <[email protected]> (`@yasoob <https://github.com/yasoob>`_)
- Paul van der Linden (`@pvanderlinden <https://github.com/pvanderlinden>`_)
- Colin Dickson (`@colindickson <https://github.com/colindickson>`_)
- Smiley Barry (`@smiley <https://github.com/smiley>`_)
- Shagun Sodhani (`@shagunsodhani <https://github.com/shagunsodhani>`_)
- Robin Linderborg (`@vienno <https://github.com/vienno>`_)
- Brian Samek (`@bsamek <https://github.com/bsamek>`_)
- Dmitry Dygalo (`@Stranger6667 <https://github.com/Stranger6667>`_)
- piotrjurkiewicz
- Jesse Shapiro <[email protected]> (`@haikuginger <https://github.com/haikuginger>`_)
- Nate Prewitt <[email protected]> (`@nateprewitt <https://github.com/nateprewitt>`_)
- Maik Himstedt
- Michael Hunsinger
- Brian Bamsch <[email protected]> (`@bbamsch <https://github.com/bbamsch>`_)
- Om Prakash Kumar <[email protected]> (`@iamprakashom <https://github.com/iamprakashom>`_)
- Philipp Konrad <[email protected]> (`@gardiac2002 <https://github.com/gardiac2002>`_)
- Hussain Tamboli <[email protected]> (`@hussaintamboli <https://github.com/hussaintamboli>`_)
- Casey Davidson (`@davidsoncasey <https://github.com/davidsoncasey>`_)
- Andrii Soldatenko (`@a_soldatenko <https://github.com/andriisoldatenko>`_)
- Moinuddin Quadri <[email protected]> (`@moin18 <https://github.com/moin18>`_)
- Matt Kohl (`@mattkohl <https://github.com/mattkohl>`_)
- Jonathan Vanasco (`@jvanasco <https://github.com/jvanasco>`_)
- David Fontenot (`@davidfontenot <https://github.com/davidfontenot>`_)
- Shmuel Amar (`@shmuelamar <https://github.com/shmuelamar>`_)
- Gary Wu (`@garywu <https://github.com/garywu>`_)
- Ryan Pineo (`@ryanpineo <https://github.com/ryanpineo>`_)
- Ed Morley (`@edmorley <https://github.com/edmorley>`_)
- Matt Liu <[email protected]> (`@mlcrazy <https://github.com/mlcrazy>`_)
3 changes: 3 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Be cordial or be on your way.

https://www.kennethreitz.org/essays/be-cordial-or-be-on-your-way
57 changes: 57 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# Contribution Guidelines

Before opening any issues or proposing any pull requests, please do the
following:

1. Read our [Contributor's Guide](http://docs.python-requests.org/en/latest/dev/contributing/).
2. Understand our [development philosophy](http://docs.python-requests.org/en/latest/dev/philosophy/).

To get the greatest chance of helpful responses, please also observe the
following additional notes.

## Questions

The GitHub issue tracker is for *bug reports* and *feature requests*. Please do
not use it to ask questions about how to use Requests. These questions should
instead be directed to [Stack Overflow](https://stackoverflow.com/). Make sure
that your question is tagged with the `python-requests` tag when asking it on
Stack Overflow, to ensure that it is answered promptly and accurately.

## Good Bug Reports

Please be aware of the following things when filing bug reports:

1. Avoid raising duplicate issues. *Please* use the GitHub issue search feature
to check whether your bug report or feature request has been mentioned in
the past. Duplicate bug reports and feature requests are a huge maintenance
burden on the limited resources of the project. If it is clear from your
report that you would have struggled to find the original, that's ok, but
if searching for a selection of words in your issue title would have found
the duplicate then the issue will likely be closed extremely abruptly.
2. When filing bug reports about exceptions or tracebacks, please include the
*complete* traceback. Partial tracebacks, or just the exception text, are
not helpful. Issues that do not contain complete tracebacks may be closed
without warning.
3. Make sure you provide a suitable amount of information to work with. This
means you should provide:

- Guidance on **how to reproduce the issue**. Ideally, this should be a
*small* code sample that can be run immediately by the maintainers.
Failing that, let us know what you're doing, how often it happens, what
environment you're using, etc. Be thorough: it prevents us needing to ask
further questions.
- Tell us **what you expected to happen**. When we run your example code,
what are we expecting to happen? What does "success" look like for your
code?
- Tell us **what actually happens**. It's not helpful for you to say "it
doesn't work" or "it fails". Tell us *how* it fails: do you get an
exception? A hang? A non-200 status code? How was the actual result
different from your expected result?
- Tell us **what version of Requests you're using**, and
**how you installed it**. Different versions of Requests behave
differently and have different bugs, and some distributors of Requests
ship patches on top of the code we supply.

If you do not provide all of these things, it will take us much longer to
fix your problem. If we ask you to clarify these and you never respond, we
will close your issue without fixing it.
Loading