chr15m / chr15m/PodSixNet

Typo in podsixnet2 package on PyPi

Open
#41 0 comments 3 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
175
Forks
34
PR merge metrics
No merged PRs in 30d

Description

Hi Chris,

When installing podsixnet2 as follows, I get an error about not being in a git repo:

```
$ pip install podsixnet2
Collecting podsixnet2
Using cached podsixnet2-2.0.1.tar.gz (12 kB)
ERROR: Command errored out with exit status 1:
command: /home/mond/python-virtualenvs/cocos2d_pyglet-1.5/bin/python -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/tmp/pip-install-vaosdd_x/podsixnet2/setup.py'"'"'; __file__='"'"'/tmp/pip-install-vaosdd_x/podsixnet2/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' egg_info --egg-base /tmp/pip-pip-egg-info-rofalij9
cwd: /tmp/pip-install-vaosdd_x/podsixnet2/
Complete output (10 lines):
fatal: not a git repository (or any of the parent directories): .git
Traceback (most recent call last):
File "", line 1, in
File "/tmp/pip-install-vaosdd_x/podsixnet2/setup.py", line 17, in
__version__ = subprocess.check_output(["git", "describe", "--tag", "--always"]).decode("utf8").strip("\n")
File "/usr/lib/python3.8/subprocess.py", line 411, in check_output
return run(*popenargs, stdout=PIPE, timeout=timeout, check=True,
File "/usr/lib/python3.8/subprocess.py", line 512, in run
raise CalledProcessError(retcode, process.args,
subprocess.CalledProcessError: Command '['git', 'describe', '--tag', '--always']' returned non-zero exit status 128.
----------------------------------------
ERROR: Command errored out with exit status 1: python setup.py egg_info Check the logs for full command output.
```

Which happens because in the setup.py file it incorrectly has the directory as podsixnet rather than podsixnet2

```python
versionfile = "podsixnet/version.py"
if not os.path.isfile(versionfile):
# assume git checkout
__version__ = subprocess.check_output(["git", "describe", "--tag", "--always"]).decode("utf8").strip("\n")
else:
# created by pip
exec(open(versionfile).read())
```

After changing `versionfile` I am able to install it.

I think it would be useful to update the 'Project description' [page](https://pypi.org/project/podsixnet2/) to explain why there are two packages and that they are functionally equivalent (as I had to delve into previous issues #26 and PRs #35 #37 to find out :smile:).

Many thanks.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with setup.py and inspect the versionfile path shown in the issue, then reproduce pip install podsixnet2 from PyPI. Done means the package installs without requiring a git checkout and the PyPI project description explains why podsixnet and podsixnet2 exist and that they are functionally equivalent.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, python
Domain
build-system, documentation
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.