Metadata-Version: 1.1
Name: edgy.project
Version: 0.1.15
Summary: Strongly opinionated python project management.
Home-page: https://github.com/python-edgy/project
Author: UNKNOWN
Author-email: UNKNOWN
License: Apache License, Version 2.0
Download-URL: https://github.com/python-edgy/project/tarball/0.1.15
Description: edgy.project
        ============
        
        Strongly opinionated python project management.
        
        This package helps you create python source trees using best practices (or at
        least the practices we consider as best for us) in a breeze.
        
        Don't worry about setting up git, a makefile, usual project targets, unit tests
        framework, pip, wheels, virtualenv, code coverage, namespace packages, setup.py
        files ... Project's got you covered on all this, using one simple and fast
        command.
        
        
        Install
        =======
        
        Before installing the package, you must make sure that `pip` and `virtualenv`
        are installed and available to be used in your current environment.
        
        .. code-block:: shell
        
            pip install edgy.project
        
        Now, you may want to bootstrap a python package source tree.
        
        .. code-block:: shell
        
            mkdir my.awesome.pkg
            cd my.awesome.pkg
            edgy-project init
        
        You're done with the bootstrap. You can now run:
        
        .. code-block:: shell
        
            make install
            make test
            git commit -m 'Damn that was fast ...'
        
        Happy?
        
        
        Update
        ======
        
        If you change the `Projectfile` content, or update the library, you will need to run
        the generator again.
        
        .. code-block:: shell
        
            edgy-project update
        
        To better control what changes are made, I suggest that you run it on a clean git
        repository, then look at the dofferences using:
        
        .. code-block:: shell
        
            git diff --cached
        
        You can then commit the generated changes.
        
        
        Gotchas
        =======
        
        As the headline says, we have made strong opinionated choices about how a project
        tree should be organized.
        
        For example, we choose to use make to provide the main project entrypoints
        (install, test). We also choose to use git. And nosetests. And to put root package
        in the project root. Etc.
        
        For beginners, that's a good thing, because they won't have to ask themselves
        questions like "What should I put in setup.py ?" or "Should I create a «src»
        dir or not ?". For more advanced users, it can be either a good thing if you
        agree with our choices, or a bad one ...
        
        
        F.A.Q
        =====
        
        * I'm using PasteScript, isn't that enough?
        
          * PasteScript with the basic_package template will only generate a very
            minimalistic tree, while we install a few tools and generate more boilerplate
            than it does. The fact is, we were using it before but still had a lot of
            repeated actions to do then, and the exact aim of this project is to automate
            the whole. Also, PasteScript cannot update a project once generated, while we
            do.
        
        * Should I use it?
        
          * You're a grown man, right?
        
        * Is it stable / production ready?
        
          * Not really relevant to this project, as it's more a development tool than
            something you'll use in operations. However, please note that on some points
            and until version 1.0, we will tune things and change the way it works to find
            the most flexible way to operate. Thus, if you relly on a specific
            implementation, updates may break things. The good news is that you'll be able
            to review changes using `git diff --cached`, and either rollback or report
            issues saying how much you're disappointed (and why, don't forget the why,
            please).
        
        * Can I contribute?
        
          * Yes, but the right vs wrong choices decision is up to us. Probably a good
            idea to discuss about it (in an issue for example) first.
        
        * Can you include feature «foo»?
        
          * Probably, or maybe not. Come on github issues to discuss it, if we agree on
            the fact this feature is good for a lot of usages, your patch will be
            welcome. Also, we're working on a simple way to write "feature plugins", so
            even if we don't agree on something, you'll be able to code and even distribute
            addons that make things work the way you like.
        
        * Do you support python 3?
        
          * Yes, edgy.project run both with python 2.7+ and python 3.4+, but we don't
            generate version specific code. For example, we don't support generating
            namespace packages that does not have __init__.py files with the python
            namespace package boilerplate.
Platform: UNKNOWN
