Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

0.1.15: missing docs/ in sdist tar ball and missing setup.py in git tree #14

Open
kloczek opened this issue Jul 16, 2021 · 2 comments
Open
Assignees

Comments

@kloczek
Copy link

kloczek commented Jul 16, 2021

Looks like still docs/ directory is not included in pypi sdits tar ball.
Additionally new version git tree has removed setup.py so no longer is possible to generate sphinx documentation using build_sphinx setuptools command.

builder/pep517 does not provide generic scaffold to build module documentation so from that point of view as well it is no longer possible to use git source tree to build documentation so remove setup.py file is kind big regress :(

@micktwomey micktwomey self-assigned this Jul 16, 2021
@micktwomey
Copy link
Owner

Thanks for the issue!

For the first question, you are you asking for the docs folder to be added to the sdist tarball? That shouldn't be a problem.

As for setup.py, I wasn't planning on keeping one around in the move to 1.0, but if I added a barebones setup.py would that work for you? I wouldn't be using it myself, so it's unlikely to get updated version numbers.

Side note: I'll keep 0.1-patches around for any changes to the 0.1.* releases, so that'll always be there if you want to repoint any tooling.

@kloczek
Copy link
Author

kloczek commented Jul 16, 2021

Will try to check setup.py generated in pypi sdist tar ball.

To just give you some context why I'm bothering you about setup.py.
I'm working on Linux/Solarix distribution and I have now +550 cleaned python modules.
Part of the typical python module spec file (used on Linu x to generate rpm package and on Solaris to build IPS package using pkgbuil rool) is generate, install and package sphinx documenatation but as roff man pages.
Part of my spec file for your module:

%prep
%autosetup -n pyiso8601-%{version}

%build
%py3_build
%py3_build_sphinx_man

%install
%py3_install

%__install build/sphinx/man/*.3 -Dt %{buildroot}%{_mandir}/man3

%check
%pytest

and ..

[tkloczko@barrel SPECS]$ rpm -E %py3_build_sphinx_man
\
        PBR_VERSION=%{version} \
        SETUPTOOLS_SCM_PRETEND_VERSION=%{version} \
        /usr/bin/python3 setup.py build_sphinx -b man --build-dir build/sphinx

Using that macro I can generate module documentation without care where in source tree exactly is copy.py file. This is very handy method and result ..

[tkloczko@barrel SPECS]$ man python-<tab><tab>
Display all 222 possibilities? (y or n)
python-amqp                           python-h2                             python-path                           python-sphinxcontrib-autoprogram
python-anytree                        python-hacking                        python-pillow                         python-sphinxcontrib-bibtex
python-argcomplete                    python-httplib2                       python-pluggy                         python-sphinxcontrib-httpdomain
python-arrow                          python-hyperframe                     python-polib                          python-sphinxcontrib-programoutput
python-"asgi                          python-hyperlink                      python-prb                            python-sphinxcontrib-trio
python-aspectlib                      python-hypothesis                     python-priority                       python-sphinxcopybutton
python-astor                          python-ifaddr                         python-productmd-compose              python-sphinxext-opengraph
python-astroid                        python-importlib-metadata             python-productmd-composeinfo          python-sphinx-inline-tabs
python-async_generator                python-inflect                        python-productmd-discinfo             python-sphinx-removed-in
python-atomicwrites                   python-ipykernel                      python-productmd-images               python-sphinx_rtd_theme
python-attrs                          python-ipythonparallel                python-productmd-rpms                 python-sphinx-tabs
python-augeas                         python-itsdangerous                   python-productmd-terminology          python-sphinx-typlog-theme
python-autodocsumm                    python-jaraco-classes                 python-productmd-treeinfo             python-sphobjinv
python-babel                          python-jaraco-collections             python-prompt_toolkit                 python-sqlparse
python-backcall                       python-jaraco-envs                    python-ptyprocess                     python-stdlib-list
python-benchmark                      python-jaraco-functools               python-purl                           python-stem
python-betamax                        python-jaraco.itertools               python-py                             python-sure
python-billiard                       python-jaraco-packaging               python-pyasn1                         python-sybil
python-bleach                         python-jaraco-path                    python-pybtex-docutils                python-systemd
python-blinker                        python-jaraco-text                    python-pycodestyle                    python-terminado
python-boto3                          python-jedi                           python-pyfakefs                       python-testpath
python-botocore                       python-Jinja                          python-pyftpdlib                      python-testrepository
python-bottle                         python-jinja2_pluralize               python-pygal                          python-test_server
python-breathe                        python-jmespath                       python-pygments                       python-testtools
python-build                          python-jupyter_client                 python-pyhamcrest                     python-tidy
python-cachetools                     python-jupyter_core                   python-pylama                         python-tinycss2
python-case                           python-kiwi                           python-pylint                         python-tornado
python-cffi                           python-kombu                          python-pymeeus                        python-traitlets
python-characteristic                 python-lark                           python-pynacl                         python-trio
python-chardet                        python-latexcodec                     python-pyopenssl                      python-trustme
python-click                          python-lazy-object-proxy              python-pyrad                          python-twisted
python-click-log                      python-libevdev                       python-pyrsistent                     python-uritemplate
python-contextlib2                    python-linkify-it-py                  python-pyscss                         python-urllib3
python-convertdate                    python-lockfile                       python-pytest                         python-validators
python-coveragepy                     python-lxml                           python-pytest-checkdocs               python-vine
python-cppy                           python-mako                           python-pytest-cov                     python-waitress
python-cssselect2                     python-markupsafe                     python-pytest-regressions             python-wcwidth
python-dateutil                       python-mdit-py-plugins                python-pytest-runner                  python-webcolors
python-dictdiffer                     python-mistune                        python-python-sphinx-contribspelling  python-webencodings
python-dpkt                           python-more-itertools                 python-pyudev                         python-webob
python-dulwich                        python-msgpack                        python-pyxattr                        python-websocket-client
python-elementpath                    python-multidict                      python-pyxdg                          python-websockets
python-evdev                          python-mypy                           python-rdflib                         python-webtest
python-execnet                        python-myst-parser                    python-requests-mock                  python-werkzeug
python-faker                          python-nbclient                       python-requests_toolbelt              python-wheel
python-fields                         python-nbformat                       python-rich                           python-wrapt
python-flake8                         python-netaddr                        python-rsa                            python-WSGIProxy2
python-flask                          python-nose2                          python-rst.linker                     python-wsproto
python-flask-sqlalchemy               python-notebook                       python-scons                          python-xmlschema
python-flit                           python-olefile                        python-scripttest                     python-yamlloader
python-fonttools                      python-openstackdocstheme             python-semantic-version               python-yarl
python-gcovr                          python-outcome                        python-service-identity               python-zeroconf
python-gidocgen                       python-paramiko                       python-smartypants                    python-zipp
python-gitdb                          python-parso                          python-smmap.tex                      python-zope-event
python-GitPython.tex                  python-parver                         python-sniffio
python-greenlet                       python-paste                          python-sphinxcontrib-asyncio

If pep517/builder would offer such generic way of generate documentation I would not bother you .. however it does't :(
A the same time:

[tkloczko@barrel SPECS]$ ls -1 python-* | wc -l
552
[tkloczko@barrel SPECS]$ grep -l %py3_build python-* | wc -l
545
[tkloczko@barrel SPECS]$ grep "build --no-isolation" python-* -l
python-flit.spec
python-rich.spec
python-sphinx-inline-tabs.spec

IMO pep517/builder/instaler modules are not ready to replace setuptools :(
So .. really please do not remove setup.py .. (at least for now)

clrpackages pushed a commit to clearlinux-pkgs/iso8601 that referenced this issue Aug 18, 2021
…0.1.16

commit 1a890730655db3bf295ce0239c1418485ed21270
Author: Michael Twomey <[email protected]>
Date:   Fri Jul 16 13:51:48 2021 +0100

    Add `docs/` to sdist

    Addresses part of micktwomey/pyiso8601#14

commit acd616c875e03447bb7f825acd92698ba5455e4f
Author: Michael Twomey <[email protected]>
Date:   Fri Jul 16 10:23:23 2021 +0100

    Fix distribution of pyi files
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants