wemake-services / jinja2-git Goto Github PK

There's a new python version that we currently do not officially support.

What need to be done:

1. We need to remove these classifiers: https://github.com/sobolevn/jinja2-git/blob/master/pyproject.toml#L30-L34
2. We need to add new python version here: https://github.com/sobolevn/jinja2-git/blob/master/pyproject.toml#L38, example: https://github.com/wemake-services/wemake-python-styleguide/blob/master/pyproject.toml#L40
3. We need to add python3.7 inside travis builds, example: https://github.com/wemake-services/wemake-python-styleguide/blob/master/.travis.yml#L3-L9

We are ready for a new release!

@mikhail-akimov but before releasing a new version, we need to add a CHANGELOG.md file where we can describe what have changed since the last version.

What needs to be done:

1. Look at the example: https://github.com/wemake-services/wemake-python-styleguide/blob/master/CHANGELOG.md
2. Write about the first version: it was just an initial release
3. Write about your changes: new features and general changes

And then I will release a new version.

I need a similar functionality to the one you provide for the git hash just for the latest git tag, i.e., the output of:
git describe --tags --abbrev=0

Would you be willing to include this into your package (could make a PR), or should I create my own package?

Currently this library only allows users to get the full commit hash.

I would see some possible usages of the short commit hash as well.
So, I would like to propose the following syntax for it: {% gitcommit short=True %}.

What needs to be done?

1. we need to find out how to pass parameters to the jinja2 tags
2. we need to add a new parameter to the _commit_hash method
3. we need to write tests for this feature
4. we need to write docs for this feature as well https://github.com/sobolevn/jinja2-git#usage

This was originally a # TODO comment: https://github.com/sobolevn/jinja2-git/blob/23172f3a7f26b6f551f70a8c6aaa818a79918e4f/jinja2_git.py#L22

After #3 was merged we have broken our CI.

Problem

Travis builds fail: https://travis-ci.org/sobolevn/jinja2-git/jobs/432398548
Traceback:

0.33s$ tox
ERROR: No setup.py file found. The expected location is:
  /home/travis/build/sobolevn/jinja2-git/setup.py
You can
  1. Create one:
     https://packaging.python.org/tutorials/distributing-packages/#setup-py
  2. Configure tox to avoid running sdist:
     https://tox.readthedocs.io/en/latest/example/general.html#avoiding-expensive-sdist
The command "tox" exited with 1.

Solution

We have to switch how our CI works. Currently it uses tox + setup.py which is gone.
But, we now need to use poetry instead.

Resources that might help you @mikhail-akimov :

1. poetry + tox travis example: https://github.com/sdispater/pendulum/blob/master/tox.ini
2. poetry travis example without tox: https://github.com/wemake-services/wemake-python-styleguide/blob/master/.travis.yml

Please, feel free to ask any questions you have.

@mikhail-akimov Currently we use rst as the legacy format that was supported via old PyPI.
But, new PyPI release also supports md. Just like poetry.

So, what we need to do is manually convert README.rst into README.md.
Could you please help me with that?

It would be nice to be able to pass the git repository to subprocess.check_output(params, cwd=repo), otherwise this returns an error message when the git repository is not in the same directory.

We still use good-old setup.py for this project.

It works well, but I do not enjoy maintaining it.
So, we need to move to poetry:

1. create pyproject.toml, it should look like this file: https://github.com/wemake-services/wemake-python-styleguide/blob/master/pyproject.toml
2. lock dependencies to create pyproject.lock
3. copy everything we need from setup.py into pyproject.toml
4. delete setup.py and MANIFEST.in files

Dependabot couldn't authenticate with https://pypi.python.org/simple/.

You can provide authentication details in your Dependabot dashboard by clicking into the account menu (in the top right) and selecting 'Config variables'.

View the update logs.

Can you make a new release, please? The last one is May 2020, but several important changes, including Jinja 3.x support (#120) have been merged since then.