semvec/pypi-packages huggingface dataset:
growup 0.3.6
Growup adds the NCoC to your project.
License: BSD
Keywords: code of conduct,floss,release management,packages

===============================
growup
===============================

Growup adds the [NCoC](https://github.com/domgetter/NCoC/) to your project. Because there ain't no Code
f Conduct like No Code of Conduct!

**Disclaimer**: This project is not affiliated with NCoC or its developers. Nor does it endorse the NCoC or express an
opposition to other codes of conduct. As a developer, I think you should be trusted with knowing what code of conduct
would benefit your project most. Maybe it's the NCoC. Maybe it's the TODO Group's CoC. Maybe it's something entirely
different. *This is a tool*, and you are to use it wisely. It is *your responsibility* to know what your project needs.

Installation
============

::

    pip install growup

After this, `growup` will be available from the command line (`growup`).

Usage
=====

`growup` is a small command line utility that adds the NCoC (No Code of Conduct) to your project.

Options
-------

```
  --root TEXT             Project root directory (default: current directory)
  --add-to-contribute     Append NCoC to CONTRIBUTING or CONTRIBUTING.md (must
                          be in root dir!)
  --add-to-file           Create a separate Code of Conduct file. Define path
                          using --output-filename
  --output-filename TEXT  Output filename and extension. Default: CODEOFCONDUCT.md.
  --help                  Show this message and exit
```

Example
-------

The following call will
- add NCoC to `CONTRIBUTING.md` in the current folder, and
- also add it to a file called `CodeOfConduct.md`

```
growup --add-to-contribute --add-to-file --output-filename CodeOfConduct.md
```

License
=======

Custom BSD-based. See the [full license here](https://chrisvoncsefalvay.com/growup/master/LICENSE).

Changelog
=========


0.3.5 (2015-08-16)
-----------------------------------------

* Small tweaks :) Now uses autoinference to figure out whether it is appending to an RST document and follows RST style
if so.


0.3.3 (2015-08-11)
-----------------------------------------

* First release on PyPI.
yamlmagic 0.2.0
a YAML magic for IPython notebooks
License: BSD
Keywords: IPython yaml

yamlmagic
=========

    an `IPython <http://ipython.org/>`__
    `magic <https://ipython.org/ipython-doc/dev/interactive/tutorial.html>`__
    for capturing data in `YAML <http://yaml.org/>`__ into a running
    IPython kernel.

|Build Status| |pypi|

.. |Build Status| image:: https://travis-ci.org/bollwyvl/yamlmagic.svg?branch=master
   :target: https://travis-ci.org/bollwyvl/yamlmagic
.. |pypi| image:: https://pypip.in/version/yamlmagic/badge.svg?style=flat

Install
-------

From the command line (or with ``!`` in a notebook cell):

.. code:: bash

    pip install yamlmagic

Enable
------

Ad-hoc
~~~~~~

In the notebook, you can use the ``%load_ext`` or ``%reload_ext`` line
magic.

.. code:: python

    %reload_ext yamlmagic

Configuration
~~~~~~~~~~~~~

In your profile's ``ipython_kernel_config.py``, you can add the
following line to automatically load ``yamlmagic`` into all your running
kernels:

.. code:: python

    c.InteractiveShellApp.extensions = ['yaml_magic']

Use
---

The ``%%yaml`` cell magic will either act as simple parser:

.. code:: python

    %%yaml
    a_toplevel_key: 1



.. parsed-literal::

    <IPython.core.display.Javascript object>




.. parsed-literal::

    {'a_toplevel_key': 1}



which can be accessed by the special last result variable ``_``:

.. code:: python

    _




.. parsed-literal::

    {'a_toplevel_key': 1}



Or will update a named variable with the parsed document:

.. code:: python

    %%yaml x
    - a: 1
      b: 2



.. parsed-literal::

    <IPython.core.display.Javascript object>


.. code:: python

    x




.. parsed-literal::

    [{'a': 1, 'b': 2}]



By default, ``yaml.SafeLoader`` will be used, which won't allow the
`powerful but
dangerous <http://pyyaml.org/wiki/PyYAMLDocumentation#LoadingYAML>`__
(and unportable) ```!python/``
tags <http://pyyaml.org/wiki/PyYAMLDocumentation#YAMLtagsandPythontypes>`__.
If you'd like to use them, provide the ``-l`` (or ``--loader``) argument
with a ``BaseLoader`` subclass available via a local variable...

.. code:: python

    from yaml import Loader
    class FooLoader(Loader):
        # some special things you have built
        pass

.. code:: python

    %%yaml --loader FooLoader
    - a: !!python/float 1
      b: !!python/float 2



.. parsed-literal::

    <IPython.core.display.Javascript object>




.. parsed-literal::

    [{'a': 1.0, 'b': 2.0}]



...or dotted-notation path to a loader:

.. code:: python

    %%yaml --loader yaml.Loader
    - a: !!python/float 1
      b: !!python/float 2



.. parsed-literal::

    <IPython.core.display.Javascript object>




.. parsed-literal::

    [{'a': 1.0, 'b': 2.0}]



Contribute
----------

`Issues <https://github.com/bollwyvl/yamlmagic/issues>`__ and `pull
requests <https://github.com/bollwyvl/yamlmagic/pulls>`__ welcome!

License
-------

``yamlmagic`` is released as free software under the `BSD 3-Clause
license <./LICENSE>`__.

Thank
-----

-  [@tonyfast](http://robclewley.github.io) for asking for this
-  [@robclewley](http://robclewley.github.io) for documentation-shaming
   a gist into a module