Packaging issues

[mdraw]

I am currently working on packaging tensorboardX for https://conda-forge.org/ and for the AUR.
For making a package, we generally need either an sdist of a released version or a tagged release on Github (or even better: both).
This shouldn't be much work and doesn't break anything:
Instead of

python setup.py build wheel
twine upload dist/*

you'd just need to run

python setup.py build sdist wheel
twine upload dist/*

I also have two quick questions:

• Am I correct that the official name of this project is now "tensorbaordX" and the name "tensorboard-pytorch" will be 100% replaced by it? If yes, would you mind also renaming your repository and the documentation page so it's less confusing for new users?
• In setup.py, you specify the license as MIT, but there is no explicit license file. Package repositories like having a very clear licensing situation, so it would help if you'd add a LICENSE with the MIT license text to your repository.

Thanks a lot for your work on making tensorboard available from pytorch, @lanpa and contributors! I am impressed with how easy it was to integrate into my pytorch code.

[lanpa]

Hi,

Does a tagged release on Github enough for packing?

I have think of renaming too, and my concern is that when people google: "tensorboard pytorch", will the renamed repo be listed on top as well? I think keeping the repository name unchanged but add additional information about tensorboardX should be clear enough.

For the license, is the following text OK? (I am not familiar with this lol)

============
MIT License

Copyright (c) 2017, Tzu-Wei Huang

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

[mdraw]

If you don't want to upload any sdists, then tagging releases on Github would also work, yes (like you did for v0.6).

I don't know how renaming the repo would affect the rank on Google/Github search (I believe it won't matter because of all the relevant keywords inside the readme etc., but I can't guarantee it).

The license text looks good!

[lanpa]

I remember some guys have compile issue when the sdist is uploaded to PyPI (long time ago). Therefore I prefer not uploading it. BTW, I will make a 0.9 release on github this weekend. So you can try your packing script later :)

[lanpa]

@mdraw Thanks for the recipe!

[mdraw]

You're welcome. Should I add you as a maintainer for the tensorboardx conda-forge recipe?

[lanpa]

Sure, thank you. I think I will still tag you whenever users have conda related questions. lol