Template (cookiecutter) for easily distributing SageMath code

[Marc Masdeu]

After some work (building upon github.com/sagemath/sage_sample) that some of us did during Sage Days 87 and the Leiden workshop that took place a few weeks ago, I'd like to collect some feedback / pull requests on a first attempt at making it super easy for anyone to get their own working GitHub/TravisCI/GHPages setup. This can be found at github.com/mmasdeu/sage_package_template.

I know that there is several people who think that this is not the way that code should be distributed. I am asking feedback from the complementary set of people, really (although constructive comments from anyone are definitely welcome!).

Thank you!

[Vincent Delecroix]

One thing (IMHO much more important than the "cookie cutter" buisness)
is to actually have a community supported language for SageMath in
travis [1]. My aim is to allow the following in the travis script

{{{
language: "SageMath"
version:
- "7.6"
- "8.0"
}}}

What need to be done

1) have 3 "official" person in charge of maintenance (with me being ok,
we need 2 more)

2) provide a pull request to travis-build and travis-web

Best
Vincent

[1]
https://docs.travis-ci.com/user/languages/community-supported-languages/

[Jeroen Demeyer]

On 2017-08-23 17:44, Marc Masdeu wrote:
> I know that there is several people who think that this is not the way
> that code should be distributed. I am asking feedback from the
> complementary set of people, really (although constructive comments from
> anyone are definitely welcome!).

My personal opinion is that "SageMath packages" should use as little
Sage-specific things as possible. In other words, a SageMath package
should really be just a Python package with a dependency on SageMath.

[Marc Masdeu]

This seems like a great idea. I am happy to be in the list of
"maintenance" people as well.

On the other issue, you are not probably the right target for the
cookie cutter thingy, but I believe that it's a quite convenient tool
if a developer has never set this up before (like myself six months
ago).
Marc
-----------------------------------------------------------------------------
marc.masdeu AT gmail DOT com
-----------------------------------------------------------------------------


On Wed, Aug 23, 2017 at 5:56 PM, Vincent Delecroix

> --
> You received this message because you are subscribed to a topic in the
> Google Groups "sage-devel" group.
> To unsubscribe from this topic, visit
> https://groups.google.com/d/topic/sage-devel/OoTNcZpAwPo/unsubscribe.
> To unsubscribe from this group and all its topics, send an email to
> sage-devel+...@googlegroups.com.
> To post to this group, send email to sage-...@googlegroups.com.
> Visit this group at https://groups.google.com/group/sage-devel.
> For more options, visit https://groups.google.com/d/optout.

[Marc Masdeu]

This is essentially what they are supposed to be. The main goal of
this cookie cutter is to easily set up the project with Travis CI and
automatic documentation generation and deployment.

Marc
-----------------------------------------------------------------------------
marc.masdeu AT gmail DOT com
-----------------------------------------------------------------------------

[Jean-Pierre Flori]

Yes!
I support this :)

My only suggestion would be to get rid of using the travis command.
And maybe move the get_all_version_names into the fake sagemath package.

[Jean-Pierre Flori]

Oh and the MANIFEST.in file is not quite good at the moment.
You could add pxd files in there.

[Erik Bray]

On Wed, Aug 23, 2017 at 5:56 PM, Vincent Delecroix
<20100.d...@gmail.com> wrote:

> One thing (IMHO much more important than the "cookie cutter" buisness) is to
> actually have a community supported language for SageMath in travis [1]. My
> aim is to allow the following in the travis script

Oh, this is wonderful! I must have missed when Travis CI opened up
this possibility. I think that would be a great idea.

Erik

> --
> You received this message because you are subscribed to the Google Groups
> "sage-devel" group.
> To unsubscribe from this group and stop receiving emails from it, send an

[Jeroen Demeyer]

On 2017-08-23 23:44, Marc Masdeu wrote:
> This is essentially what they are supposed to be.

But it's not what your package does! You are using "sage" all over the
place.

[Erik Bray]

I'm probably missing something, but I don't see where it's using
"sage" except in the docbuild (so sage would be a doc dependency).
This isn't a big deal though (and I hope, eventually, the sage
docbuild tools will be split into a separate package).