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.

Sign up for GitHub

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

Jump to bottom

Default README format to Markdown in "new" (#280) #1515

Closed
wants to merge 12 commits into from
Closed

Default README format to Markdown in "new" (#280) #1515

wants to merge 12 commits into from

Conversation

finswimmer
Copy link
Member

This PR implements #280.

NEW

  • A new parameter called --readme for poetry new is introduced, which used for defining the README format. This can be set either to md or rst
  • The readme is included in the pyproject.toml

CHANGE

  • The default README format is now .md

FIX

  • Test for poetry new is added

Pull Request Check List

This is just a reminder about the most common mistakes. Please make sure that you tick all appropriate boxes. But please read our contribution guide at least once, it will save you unnecessary review cycles!

  • Added tests for changed code.
  • Updated documentation for changed code.

Note: If your Pull Request introduces a new feature or changes the current behavior, it should be based
on the develop branch. If it's a bug fix or only a documentation update, it should be based on the master branch.

If you have any questions to any of the points above, just submit and ask! This checklist is here to help you, not to deter you from contributing!

finswimmer77@gmail.com added 5 commits October 29, 2019 20:56
This PR implements python-poetry#280.
5396000 
**NEW**

* A new parameter called `--readme` for `poetry new` is introduced, which used for defining the README format. This can be set either to `md` or `rst`
* The readme is included in the `pyproject.toml`

**CHANGE**

* The default README format is now `.md`

**FIX**

* Test for `poetry new` is added
**FIX:**
c480492 
* Update documentation
FIX: added readme = "README.md" in expected output of `test_init.py…
18478ae 
…` tests
FIX: convert Path to str in clear_new_project
4739a98
FIX: import glob from poetry.utils._compat to be python 2.7 compa…
6c6e48f 
…tible
@finswimmer finswimmer closed this Oct 30, 2019
@finswimmer finswimmer reopened this Oct 30, 2019
kasteph
kasteph previously approved these changes Nov 3, 2019
View reviewed changes
Copy link
Member

@kasteph kasteph left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution @finswimmer! 🍡 💫

The PR looks good to me with two small comments but these aren't blockers necessarily for merging. @sdispater what do you think of having Markdown as the default readme format?

docs/docs/cli.md Outdated Show resolved Hide resolved
poetry/layouts/layout.py Outdated Show resolved Hide resolved
@finswimmer
Copy link
Member Author

The isort check is new, isn't it?

This would change > 100 files. Should I really do this?

@finswimmer finswimmer mentioned this pull request Nov 19, 2019
Closed
2 tasks
@finswimmer finswimmer added the kind/feature Feature requests/implementations label Dec 13, 2019
@eyalev
Copy link
Contributor

eyalev commented Apr 16, 2020

Any updates?

@finswimmer finswimmer force-pushed the issue-280-readme-md-default branch from 8a70d79 to 6fa062c Compare June 8, 2020 06:31
@finswimmer finswimmer requested a review from a team June 11, 2020 17:31
@finswimmer finswimmer mentioned this pull request Aug 5, 2020
Merged
abn added a commit to abn/poetry that referenced this pull request Aug 6, 2020
@finswimmer @abn
command/new: make readme format configurable
80201d0 
This change makes readme formant configurable, defaulting to markdown
when using the new command.

Resolves: python-poetry#280
Closes: python-poetry#1515

Co-authored-by: Arun Babu Neelicattu <arun.neelicattu@gmail.com>
@abn abn requested a review from kasteph August 24, 2020 13:05
abn added a commit to abn/poetry that referenced this pull request Aug 27, 2020
@finswimmer @abn
command/new: make readme format configurable
1d62ac9 
This change makes readme formant configurable, defaulting to markdown
when using the new command.

Resolves: python-poetry#280
Closes: python-poetry#1515

Co-authored-by: Arun Babu Neelicattu <arun.neelicattu@gmail.com>
@abn
Copy link
Member

abn commented Aug 29, 2020

Closing this in favour of #2768.

@finswimmer @stephsamson can we get that one approved? This change is included there.

@abn abn closed this Aug 29, 2020
abn added a commit to abn/poetry that referenced this pull request Sep 1, 2020
@finswimmer @abn
command/new: make readme format configurable
5ab216f 
This change makes readme formant configurable, defaulting to markdown
when using the new command.

Resolves: python-poetry#280
Closes: python-poetry#1515

Co-authored-by: Arun Babu Neelicattu <arun.neelicattu@gmail.com>
abn added a commit to abn/poetry that referenced this pull request Sep 22, 2020
@finswimmer @abn
command/new: make readme format configurable
971a739 
This change makes readme formant configurable, defaulting to markdown
when using the new command.

Resolves: python-poetry#280
Closes: python-poetry#1515

Co-authored-by: Arun Babu Neelicattu <arun.neelicattu@gmail.com>
@jamilraichouni
Copy link

jamilraichouni commented Nov 26, 2020 •
edited
Loading

This PR implements #280.

NEW

  • A new parameter called --readme for poetry new is introduced, which used for defining the README format. This can be set either to md or rst

Hi!

First many thanks for that tool!

From above, will README.md with poetry new and flag --readme be possible in any future release?

In fact I'd like to be able to control getting a Markdown README.md as it is quite common for project top level README files (e. g. this poetry and other projects on GitHub, GitLab and more).

Thank you,
Jamil

abn added a commit to abn/poetry that referenced this pull request Apr 9, 2021
@finswimmer @abn
command/new: make readme format configurable
81d4119 
This change makes readme formant configurable, defaulting to markdown
when using the new command.

Resolves: python-poetry#280
Closes: python-poetry#1515

Co-authored-by: Arun Babu Neelicattu <arun.neelicattu@gmail.com>
abn added a commit to abn/poetry that referenced this pull request Apr 10, 2021
@finswimmer @abn
command/new: make readme format configurable
152d720 
This change makes readme formant configurable, defaulting to markdown
when using the new command.

Resolves: python-poetry#280
Closes: python-poetry#1515

Co-authored-by: Arun Babu Neelicattu <arun.neelicattu@gmail.com>
abn added a commit that referenced this pull request Apr 12, 2021
@finswimmer @abn
command/new: make readme format configurable
affabe0 
This change makes readme formant configurable, defaulting to markdown
when using the new command.

Resolves: #280
Closes: #1515

Co-authored-by: Arun Babu Neelicattu <arun.neelicattu@gmail.com>
@github-actions GitHub Actions
Copy link

github-actions bot commented Mar 1, 2024

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 1, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@kasteph kasteph kasteph approved these changes

Assignees
No one assigned
Labels
kind/feature Feature requests/implementations
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@finswimmer @eyalev @abn @jamilraichouni @kasteph