mirror of https://github.com/tqdm/tqdm.git
regenerate README.rst, add notes in CONTRIBUTING.md
This commit is contained in:
Casper da Costa-Luis
parent
4286498c14
commit
bde410de51
|
|
@ -28,8 +28,8 @@ typical steps would be:
|
|||
3. make a local clone: `git clone https://github.com/your_account/tqdm.git`
|
||||
4. make changes on the local copy
|
||||
5. test (see below) and commit changes `git commit -a -m "my message"`
|
||||
6. `push` to your github account: `git push origin`
|
||||
7. create a Pull Request (PR) from your github fork
|
||||
6. `push` to your GitHub account: `git push origin`
|
||||
7. create a Pull Request (PR) from your GitHub fork
|
||||
(go to your fork's webpage and click on "Pull Request."
|
||||
You can then add a message to describe your proposal.)
|
||||
|
||||
|
|
@ -103,15 +103,15 @@ Note: tools can be used to automate this process, such as
|
|||
|
||||
## Checking setup.py
|
||||
|
||||
To check that the `setup.py` file is compliant with PyPi requirements (e.g.
|
||||
version number; reStructuredText in README.rst) use:
|
||||
To check that the `setup.py` file is compliant with PyPI requirements (e.g.
|
||||
version number; reStructuredText in `README.rst`) use:
|
||||
|
||||
```
|
||||
[python setup.py] make testsetup
|
||||
```
|
||||
|
||||
To upload just metadata (including overwriting mistakenly uploaded metadata)
|
||||
to PyPi, use:
|
||||
to PyPI, use:
|
||||
|
||||
```
|
||||
[python setup.py] make pypimeta
|
||||
|
|
@ -190,7 +190,7 @@ Formally publishing requires additional steps: testing and tagging.
|
|||
|
||||
- ensure that all online CI tests have passed
|
||||
- check `setup.py` and `MANIFEST.in` - which define the packaging
|
||||
process and info that will be uploaded to [pypi](https://pypi.org) -
|
||||
process and info that will be uploaded to [PyPI](https://pypi.org) -
|
||||
using `[python setup.py] make installdev`
|
||||
|
||||
### Tag
|
||||
|
|
@ -219,34 +219,35 @@ Finally, upload everything to pypi. This can be done easily using the
|
|||
[python setup.py] make pypi
|
||||
```
|
||||
|
||||
Also, the new release can (should) be added to `github` by creating a new
|
||||
Also, the new release can (should) be added to GitHub by creating a new
|
||||
release from the web interface; uploading packages from the `dist/` folder
|
||||
created by `[python setup.py] make build`.
|
||||
The [wiki] can be automatically updated with github release notes by
|
||||
The [wiki] can be automatically updated with GitHub release notes by
|
||||
running `make` within the wiki repository.
|
||||
|
||||
[wiki]: https://github.com/tqdm/tqdm/wiki
|
||||
|
||||
### Notes
|
||||
|
||||
- you can also test on the pypi test servers `test.pypi.org`
|
||||
- you can also test on the PyPI test servers `test.pypi.org`
|
||||
before the real deployment
|
||||
- in case of a mistake, you can delete an uploaded release on pypi, but you
|
||||
- in case of a mistake, you can delete an uploaded release on PyPI, but you
|
||||
cannot re-upload another with the same version number
|
||||
- in case of a mistake in the metadata on pypi (e.g. bad README),
|
||||
- in case of a mistake in the metadata on PyPI (e.g. bad README),
|
||||
updating just the metadata is possible: `[python setup.py] make pypimeta`
|
||||
|
||||
|
||||
## Updating Websites
|
||||
|
||||
The most important file is `README.rst`, which sould always be kept up-to-date
|
||||
The most important file is `.readme.rst`, which should always be kept up-to-date
|
||||
and in sync with the in-line source documentation. This will affect all of the
|
||||
following:
|
||||
|
||||
- `README.rst` (generated by `mkdocs.py` during `make build`)
|
||||
- The [main repository site](https://github.com/tqdm/tqdm) which automatically
|
||||
serves the latest `README.rst` as well as links to all of github's features.
|
||||
serves the latest `README.rst` as well as links to all of GitHub's features.
|
||||
This is the preferred online referral link for `tqdm`.
|
||||
- The [PyPi mirror](https://pypi.org/project/tqdm) which automatically
|
||||
- The [PyPI mirror](https://pypi.org/project/tqdm) which automatically
|
||||
serves the latest release built from `README.rst` as well as links to past
|
||||
releases.
|
||||
- Many external web crawlers.
|
||||
|
|
|
|||
|
|
@ -337,8 +337,8 @@ Parameters
|
|||
automatically and a metric prefix following the
|
||||
International System of Units standard will be added
|
||||
(kilo, mega, etc.) [default: False]. If any other non-zero
|
||||
number, will scale ``total`` and ``n``.
|
||||
* dynamic_ncols : bool, optional
|
||||
number, will scale ```total`` and ``n``.
|
||||
If set, constantly alters ``ncols`` to the environment (allowing
|
||||
for window resizes) [default: False].
|
||||
* smoothing : float, optional
|
||||
|
|
@ -353,7 +353,8 @@ Parameters
|
|||
'{rate_fmt}{postfix}]'
|
||||
Possible vars: l_bar, bar, r_bar, n, n_fmt, total, total_fmt,
|
||||
percentage, rate, rate_fmt, rate_noinv, rate_noinv_fmt,
|
||||
rate_inv, rate_inv_fmt, elapsed, remaining, desc, postfix.
|
||||
rate_inv, rate_inv_fmt, elapsed, elapsed_s, remaining,
|
||||
remaining_s, desc, postfix, unit.
|
||||
Note that a trailing ": " is automatically removed after {desc}
|
||||
if the latter is empty.
|
||||
* initial : int, optional
|
||||
|
|
@ -379,7 +380,8 @@ Extra CLI Options
|
|||
String buffer size in bytes [default: 256]
|
||||
used when ``delim`` is specified.
|
||||
* bytes : bool, optional
|
||||
If true, will count bytes and ignore ``delim``.
|
||||
If true, will count bytes, ignore ``delim``, and default
|
||||
``unit_scale`` to True, ``unit_divisor`` to 1024, and ``unit`` to 'B'.
|
||||
* manpath : str, optional
|
||||
Directory in which to install tqdm man pages.
|
||||
* log : str, optional
|
||||
|
|
|
|||
Loading…
Reference in New Issue