Skip to content

Commit 0f8660b

Browse files
committed
Rename package to pytypedstream to allow PyPI upload
There is already a package named typed-stream on PyPI, so it doesn't allow uploading this package as typedstream, because the names are too similar. https://pypi.org/project/typed-stream/ The actual Python package is still called typestream as before. The command-line tool was already called pytypedstream.
1 parent 9f8946e commit 0f8660b

File tree

2 files changed

+7
-24
lines changed

2 files changed

+7
-24
lines changed

README.md

Lines changed: 6 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# `typedstream`
1+
# `pytypedstream`
22

33
A pure Python, cross-platform library/tool for reading Mac OS X and NeXTSTEP typedstream files.
44

@@ -59,36 +59,19 @@ and will be installed automatically as needed.
5959

6060
## Installation
6161

62-
`typedstream` is compatible with Python 3.6 or later.
63-
64-
`typedstream` is unfinished and unreleased,
65-
so it is not available on PyPI yet.
66-
If you want to use it anyway,
67-
you need to clone/download the source code and install it by running this `pip` command in the source directory:
62+
`pytypedstream` is available [on PyPI](https://pypi.org/project/pytypedstream/) and can be installed using `pip`:
6863

6964
```sh
70-
python3 -m pip install .
65+
$ python3 -m pip install pytypedstream
7166
```
7267

73-
If you update your clone or otherwise modify the code,
74-
you need to re-run the install command.
75-
You can get around the reinstall requirement by installing the package in "editable" mode:
68+
Alternatively you can download the source code manually,
69+
and run this command in the source code directory to install it:
7670

7771
```sh
78-
python3 -m pip install --editable .
72+
python3 -m pip install .
7973
```
8074

81-
In editable mode,
82-
changes to the source code take effect immediately without a reinstall.
83-
This doesn't work perfectly in all cases though,
84-
especially if the package metadata
85-
(pyproject.toml, setup.cfg, setup.py, `__version__`, etc.)
86-
has changed.
87-
If you're using an editable install and experience any problems with the package,
88-
please try re-running the editable install command,
89-
and if that doesn't help,
90-
try using a regular (non-editable) installation instead.
91-
9275
## Examples
9376

9477
### Simple example

setup.cfg

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[metadata]
2-
name = typedstream
2+
name = pytypedstream
33
version = attr: typedstream.__version__
44
url = https://github.com/dgelessus/python-typedstream
55
author = dgelessus

0 commit comments

Comments
 (0)