How to install?

[GeoffreyPlitt]

I'm interested in running this as a user, not hacking around on it, so I figured it would be available in python repos.

I tried:

sudo pip install python-chess-annotator

and got "No matching distribution found for chess-annotator".

Is there a way to install this with pip?

[rpdelaney]

Nothing that fancy at this point. You can just download the script, put it anywhere in your $PATH and execute it.

[GeoffreyPlitt]

Gotcha, thanks!

[rpdelaney]

FYI, this is now in pypi as chess-annotator.

[GeoffreyPlitt]

sweet!

[Entze]

For me there seems to be a problem. If I use pip3 install chess-annotator it installs a non-working binary in /usr/bin/annotator.

[rpdelaney]

I use archlinux. I don't know much about how pip works on other distributions (or how it works at all, really). But I have had luck with pip3 install --user sometimes. Try it?

Btw, when you say "non-working" what does that mean exactly?

[Entze]

I'm using Solus 3
sudo pip3 install chess-annotator results in the following:
A binary in /usr/bin/annotator which when called (with or without sudo) gives the following output:

Traceback (most recent call last):
  File "/usr/bin/annotator", line 11, in <module>
    load_entry_point('chess-annotator==1.1.0', 'console_scripts', 'annotator')()
  File "/usr/lib/python3.5/site-packages/pkg_resources/__init__.py", line 565, in load_entry_point
    return get_distribution(dist).load_entry_point(group, name)
  File "/usr/lib/python3.5/site-packages/pkg_resources/__init__.py", line 2631, in load_entry_point
    return ep.load()
  File "/usr/lib/python3.5/site-packages/pkg_resources/__init__.py", line 2291, in load
    return self.resolve()
  File "/usr/lib/python3.5/site-packages/pkg_resources/__init__.py", line 2297, in resolve
    module = __import__(self.module_name, fromlist=['__name__'], level=0)
ImportError: No module named 'annotator'

python3 -m annotator -h(with or without sudo):

/usr/bin/python3: No module named annotator

python3 -m chess-annotator or python-chess-annotator give similar results.

Using the --user flag when installing results in the same binary but now in the $HOME/.local/bin directory where this error log is shown when called

Traceback (most recent call last):
  File ".local/bin/annotator", line 11, in <module>
    load_entry_point('chess-annotator==1.1.0', 'console_scripts', 'annotator')()
  File "/usr/lib/python3.5/site-packages/pkg_resources/__init__.py", line 565, in load_entry_point
    return get_distribution(dist).load_entry_point(group, name)
  File "/usr/lib/python3.5/site-packages/pkg_resources/__init__.py", line 2631, in load_entry_point
    return ep.load()
  File "/usr/lib/python3.5/site-packages/pkg_resources/__init__.py", line 2291, in load
    return self.resolve()
  File "/usr/lib/python3.5/site-packages/pkg_resources/__init__.py", line 2297, in resolve
    module = __import__(self.module_name, fromlist=['__name__'], level=0)
ImportError: No module named 'annotator'

python3 -m ... still does not work in all variations

Cloning the repo works as expected though so I assume something does not work with the packaging.

[rpdelaney]

I've now tested this on OSX as well and it seems to be working fine. I'm not sure what to suggest since I can't reproduce the issue. You may want to raise this with your community support channels for Solus.

[gbtami]

Stop! The .tar.gz is incomplete. __main__.py and eco.json are both missing from source distribution you created and uploaded to pypi. The reason is some incorrect setup.py lines.
1.packages=find_packages(exclude=['contrib', 'docs', 'tests']),
this will never find annotator ez a package bacause it's not a package (missing __init__.py)
2. package_data={'eco': ['eco/eco.json'],},
same problem. There is no eco package at all to find any data file inside it.

Btw. if someone creates a clone from your project it contains an empty eco dir and inside annotator/eco an invalid link pointing to ../../eco/eco.json
Maybe you should remove eco @ 8ef60f8 from your git repo(?)

[rpdelaney]

A few things off the cuff before I look into this more deeply:

1. eco.json comes from a submodule. If you clone the repo, you have to sync the submodule separately using (I think) git submodule update since a clone does not do that automatically (for reasons I don't really understand).
   Since I have that submodule updated in my local copy, it should be included in the pypi package. The file is there in the filesystem.

2. I'm no expert on how to make python packages, as this is the first time I've done it. But my understanding is that __init__.py is not a hard requirement in a package that will never be imported in another app.

3. I don't understand how what you're saying about the broken-ness of the pypi package can be true at all, since I have installed it via pip3 on a separate system and it seems to work fine. But I'll take a closer look when I get the time.

[gbtami]

1. Solved. Thx!

2. Correct. But if you don't have __init__.py you should use py_modules=[] instead of packages=[] in setup.py

3. You can download .tar.gz (what you uploaded to pypi) from https://pypi.python.org/pypi/chess-annotator/1.1.0 Look into it to see what files are missing.

All in all to create a correct source distribution on pypi you have to make a decision.

If you want eco.json to be a package data file (meaning it can be installed OS independent way, just right under your annotator package dir) you have to make annotator a package (adding __init__.py).

If you don't want annotator to be a Python package (just a pure module) you have to install eco.py in data_files=[] (instead of package_data=[]), but then you have to add some code later to find it.

Anyway, you have to do something with your project layout unless your symlinked eco.json data file will be hard to handle with setup.py
Maybe removing annotator/eco/eco.json symlink and moving eco git submodule under annotator/ can help.