Users can now write the content in the "create" method.

[saroad2]

Now, you don't have to create the news fragment and then edit it. You can write the content dynamically!

[codecov-io]

Codecov Report

Merging #275 (a807a96) into master (0df024e) will increase coverage by 0.34%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master     #275      +/-   ##
==========================================
+ Coverage   89.49%   89.84%   +0.34%     
==========================================
  Files          11       11              
  Lines         438      453      +15     
  Branches       87       91       +4     
==========================================
+ Hits          392      407      +15     
  Misses         25       25              
  Partials       21       21              

Impacted Files	Coverage Δ
src/towncrier/create.py	100.00% <100.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0df024e...2ee34f4. Read the comment docs.

[saroad2]

Any chance someone take a look at it? It's the only thing preventing me from using Towncrier in my projects.

[saroad2]

@Julian, any feedback on this?

[altendky]

This is a great feature to add, thanks for the work on this. I am a bit concerned about developing and maintaining our own editor though. I wasn't familiar with this feature but as I searched around I ran across click.edit() which seems applicable. Do you think it would work well here?

https://click.palletsprojects.com/en/7.x/utils/#launching-editors

[saroad2]

Hey @altendky , click.edit was an excellent idea! thanks for that.

Now, it allowed us another functionality that wasn't supported before: if the user does not save the file created by the edit method, we abort without creating the new news fregmant.

If something else is needed to be done in order to merge this PR, let me know.

[altendky]

Thanks for the continued help with this and the quick turnaround.

[altendky]

There are some miscellaneous details I might like to tweak. Would you prefer I raise them here or just follow up afterwards myself? I'm fine with either but don't want to put you through every little tidbit unless you specifically want to.

Thanks again for this PR.

[saroad2]

@altendky no problem mate, if you still think there additional things that need to be done related to this PR, feel free to add comments about them and I'll try to fix those ASAP.

One thing that I would like to ask is that after we do merge this PR, you would publish a new towncrier version so I could start using this new ability. As I said, this is the only thing preventing me from using towncrier ATM.

[altendky]

@saroad2, I try not to make promises on work like this but my intent is to work through the open PRs and bugs and get a release out. Who knows, maybe I give up part way through and do a release earlier.

[seberg]

@altendky just wanted to give some kudos! It is very cool to see you picking up maintenance of towncrier. It has worked well for us at NumPy the past year (I think we may still be using the master branch, but that hardly matters).

[altendky]

Do you know the details of the various ways to exit a click program and which is best? (and why :]) I wasn't even aware that ctx.exit() existed.

[saroad2]

ctx.exit means exit the program with code.
You can always use the python return directive if you want, but it means that the exit code would be 0.

Here, I chose to exit with code 1 because if the user did not write content, it means the operation has "failed", and the exit code should reflect that.

As for the use of ctx.exit, click has this real bad habit of wrapping built-in python methods with click functions (for example, wrapping the print method in click.echo). I don't like it at all, but I take it as a conversion when working with click (this is related to our mocking discussion). In our case, we could simply use sys.exit instead and it would do the same.

To sum up, ctx.exit is the best choice, considering that it is a convention.

[altendky]

I agree a non-zero exit code is sensible, my only question was how to do it. I asked about this in the Click discord and the only answer I got was sys.exit(), but I think they hadn't heard of ctx.exit() either. :] Anyways, click.echo() does do more than print especially when dealing across Python versions and platforms. There's lots of room for major hassle when trying to handle that at the lower levels.

[altendky]

@saroad2, thanks again for both the initial submission and continuing to work through this with me.

[saroad2]

Thank you so much @altendky ! I had a great time working on this.

I really like towncrier. I think it's such a great tool.
I wanted to integrate it into my repos (both open-source and work-related) for quite some time now. I think that once you publish a new version, I'll be able to do so!