Git Product home page Git Product logo

Comments (9)

cjerdonek avatar cjerdonek commented on July 21, 2024 1

I'm a big fan and user of both tox and Travis, but for several reasons, I think it would be better for this particular project to lean more towards a "minimal" sample project that doesn't favor particular tools, etc.

I do think it's valuable to have sample projects that incorporate a lot more (doc toolchain, testing toolchain, etc), but I think it would be better for that to be in addition to a minimal project.

from sampleproject.

pfmoore avatar pfmoore commented on July 21, 2024

Makes sense if tox/travis is the recommended practice. We're getting very close to workflow recommendations here rather than simple packaging recommendations. I think it's needed, and in general I'm +1 on this, but we want to keep in mind what we're trying to cover at the same time.

See also my issue (to be added) about test layout...

from sampleproject.

pfmoore avatar pfmoore commented on July 21, 2024

You should probably add a short explanation of tox.ini/.travis.yml into the README as well.

from sampleproject.

jcjf avatar jcjf commented on July 21, 2024

Would this get a bit out of hand if you then added docs (Sphinx). Is the goal to just educate on modern best practices for distutils/setuptools (what I was hoping to learn), or is the scope wider than that?

from sampleproject.

pfmoore avatar pfmoore commented on July 21, 2024

My original reason for creating this project was to have a template covering best practices, so testing, docs, etc. So on that basis, docs is definitely in scope. Whether that is still the case now that the project has been put under the pypa umbrella is less clear.

If docs and testing are in scope, then someone else will have to set up those parts. I don't know enough to do so.

If you just want to get going with a template, then it may be worth your while looking at cookiecutter - they have a couple of very comprehensive templates (too comprehensive for what I was trying to do, but that's a pretty fine distinction at times...)

from sampleproject.

Ivoz avatar Ivoz commented on July 21, 2024

I think for 3rd party stuff, maybe telling people about it is good enough (even saying "look at what x and y have done!"), rather than personally needing to demonstrate everything.

from sampleproject.

VelizarVESSELINOV avatar VelizarVESSELINOV commented on July 21, 2024

👍 I'm for favorable a complete default project, including all the quality online aspects:

  • CI like Travis, Circle, etc.
  • static code analysis like Quantifiedcode, Codacy, etc.
  • code coverage like Coveralls, Codecov, etc.
  • documentation like Read the Docs, etc.
  • license like MIT, BSD, etc. (#17)

After that how you manage all the possible combinations, if a user want to have a project that is licensed X, CI Y, etc. can be challenging.

One solution is to have several GitHub projects, single project with different branches or build a project template wizard that is creating the project with some user selected options.

from sampleproject.

pfmoore avatar pfmoore commented on July 21, 2024

If we include travis, we should probably also include appveyor, to encourage testing cross-platform.

from sampleproject.

gene1wood avatar gene1wood commented on July 21, 2024

This was completed in PR #37 . Is this issue clear to be closed?

from sampleproject.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.