===========
conda-build
===========
.. image:: https://travis-ci.org/conda/conda-build.svg?branch=master
:target: https://travis-ci.org/conda/conda-build
.. image:: https://ci.appveyor.com/api/projects/status/07r1m8fy55jee9th?svg=true
:target: https://ci.appveyor.com/project/ContinuumAnalyticsFOSS/conda-build
.. image:: https://www.quantifiedcode.com/api/v1/project/1960a96404aa431bab5d834edff1cf85/badge.svg
:target: https://www.quantifiedcode.com/app/project/1960a96404aa431bab5d834edff1cf85
:alt: Code issues
.. image:: https://codecov.io/gh/conda/conda-build/branch/master/graph/badge.svg
:target: https://codecov.io/gh/conda/conda-build
.. image:: https://landscape.io/github/conda/conda-build/master/landscape.svg?style=flat
:target: https://landscape.io/github/conda/conda-build/master
:alt: Code Health
Installation
--------------
.. code:: bash
# Display information about current conda install
conda info
# Install conda-build in the current env
conda install -n root conda-build
Building Your Own Packages
--------------------------
You can easily build your own packages for conda, and upload them to `anaconda.org
<https://anaconda.org>`_, a free service for hosting packages for conda, as
well as other package managers. To build a package, create a recipe. See
http://github.com/conda/conda-recipes for many example recipes, and
http://conda.pydata.org/docs/build.html for documentation on how to build
recipes.
To upload to anaconda.org, create an account. Then, install the anaconda-client
and login
.. code-block:: bash
$ conda install anaconda-client
$ anaconda login
Then, after you build your recipe
.. code-block:: bash
$ conda build <recipe-dir>
you will be prompted to upload to anaconda.org.
To add your anaconda.org channel, or the channel of others to conda so that ``conda
install`` will find and install their packages, run
.. code-block:: bash
$ conda config --add channels https://conda.anaconda.org/username
(replacing ``username`` with the user name of the person whose channel you want
to add).
Gotchas/FAQ
-----------
* ```OSError: [Errno 36] File name too long:``` - This error has been seen on Linux computers with encrypted folders. The solution is to install miniconda or anaconda to a location that is not encrypted. This error occurs because the encrypted form of the path that conda-build creates can be too long.
Getting Help
------------
The documentation for conda is at http://conda.pydata.org/docs/. You can
subscribe to the `conda mailing list
<https://groups.google.com/a/continuum.io/forum/#!forum/conda>`_. The source
code and issue tracker for conda are on `GitHub <https://github.com/pydata/conda>`_.
Contributing
------------
Contributions to conda-build are always welcome! Please fork the
conda/conda-build repository, and submit a PR. If a PR is a work in progress,
please put [WIP] in the title. Contributions are expected to pass flake8 and
test suites run on Travis CI (linux) and AppVeyor (windows). Contributors also
need to have signed our `Contributor License Agreement
<https://www.clahub.com/agreements/conda/conda-build>`_
Testing
-------
Running our test suite requires cloning one other repo at the same level as conda-build:
https://github.com/conda/conda_build_test_recipe - this is necessary for relative path tests
outside of conda build's build tree.
Additionally, you need to install a few extra packages:
.. code-block:: bash
conda install pytest pytest-cov mock
The test suite runs with py.test. Some useful commands to run select tests,
assuming you are in the conda-build root folder:
Run all tests:
==============
py.test tests
Run one test function:
======================
py.test tests/test_api_build.py::test_early_abort
Run one parameter of one parametrized test function:
====================================================
Several tests are parametrized, to run some small change, or build several
recipe folders. To choose only one of them:
py.test tests/test_api_build.py::test_recipe_builds.py[entry_points]
Note that our tests use py.test fixtures extensively. These sometimes trip up IDE
style checkers about unused or redefined variables. These warnings are safe to
ignore.
Raw data
{
"_id": null,
"home_page": "https://github.com/conda/conda-build",
"name": "conda-build",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Continuum Analytics, Inc.",
"author_email": "conda@continuum.io",
"download_url": "",
"platform": "UNKNOWN",
"description": "===========\nconda-build\n===========\n\n.. image:: https://travis-ci.org/conda/conda-build.svg?branch=master\n :target: https://travis-ci.org/conda/conda-build\n\n.. image:: https://ci.appveyor.com/api/projects/status/07r1m8fy55jee9th?svg=true\n :target: https://ci.appveyor.com/project/ContinuumAnalyticsFOSS/conda-build\n\n.. image:: https://www.quantifiedcode.com/api/v1/project/1960a96404aa431bab5d834edff1cf85/badge.svg\n :target: https://www.quantifiedcode.com/app/project/1960a96404aa431bab5d834edff1cf85\n :alt: Code issues\n\n.. image:: https://codecov.io/gh/conda/conda-build/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/conda/conda-build\n\n.. image:: https://landscape.io/github/conda/conda-build/master/landscape.svg?style=flat\n :target: https://landscape.io/github/conda/conda-build/master\n :alt: Code Health\n\n\nInstallation\n--------------\n.. code:: bash\n\n # Display information about current conda install\n conda info\n\n # Install conda-build in the current env\n conda install -n root conda-build\n\n\nBuilding Your Own Packages\n--------------------------\n\nYou can easily build your own packages for conda, and upload them to `anaconda.org\n<https://anaconda.org>`_, a free service for hosting packages for conda, as\nwell as other package managers. To build a package, create a recipe. See\nhttp://github.com/conda/conda-recipes for many example recipes, and\nhttp://conda.pydata.org/docs/build.html for documentation on how to build\nrecipes.\n\nTo upload to anaconda.org, create an account. Then, install the anaconda-client\nand login\n\n.. code-block:: bash\n\n $ conda install anaconda-client\n $ anaconda login\n\nThen, after you build your recipe\n\n.. code-block:: bash\n\n $ conda build <recipe-dir>\n\nyou will be prompted to upload to anaconda.org.\n\nTo add your anaconda.org channel, or the channel of others to conda so that ``conda\ninstall`` will find and install their packages, run\n\n.. code-block:: bash\n\n $ conda config --add channels https://conda.anaconda.org/username\n\n(replacing ``username`` with the user name of the person whose channel you want\nto add).\n\nGotchas/FAQ\n-----------\n\n* ```OSError: [Errno 36] File name too long:``` - This error has been seen on Linux computers with encrypted folders. The solution is to install miniconda or anaconda to a location that is not encrypted. This error occurs because the encrypted form of the path that conda-build creates can be too long.\n\nGetting Help\n------------\n\nThe documentation for conda is at http://conda.pydata.org/docs/. You can\nsubscribe to the `conda mailing list\n<https://groups.google.com/a/continuum.io/forum/#!forum/conda>`_. The source\ncode and issue tracker for conda are on `GitHub <https://github.com/pydata/conda>`_.\n\n\nContributing\n------------\n\nContributions to conda-build are always welcome! Please fork the\nconda/conda-build repository, and submit a PR. If a PR is a work in progress,\nplease put [WIP] in the title. Contributions are expected to pass flake8 and\ntest suites run on Travis CI (linux) and AppVeyor (windows). Contributors also\nneed to have signed our `Contributor License Agreement\n<https://www.clahub.com/agreements/conda/conda-build>`_\n\nTesting\n-------\n\nRunning our test suite requires cloning one other repo at the same level as conda-build:\nhttps://github.com/conda/conda_build_test_recipe - this is necessary for relative path tests\noutside of conda build's build tree.\n\nAdditionally, you need to install a few extra packages:\n\n.. code-block:: bash\n\n conda install pytest pytest-cov mock\n\nThe test suite runs with py.test. Some useful commands to run select tests,\nassuming you are in the conda-build root folder:\n\nRun all tests:\n==============\n\n py.test tests\n\nRun one test function:\n======================\n\n py.test tests/test_api_build.py::test_early_abort\n\nRun one parameter of one parametrized test function:\n====================================================\n\nSeveral tests are parametrized, to run some small change, or build several\nrecipe folders. To choose only one of them:\n\n py.test tests/test_api_build.py::test_recipe_builds.py[entry_points]\n\nNote that our tests use py.test fixtures extensively. These sometimes trip up IDE\nstyle checkers about unused or redefined variables. These warnings are safe to\nignore.",
"bugtrack_url": null,
"license": "BSD 3-clause",
"summary": "tools for building conda packages",
"version": "2.1.5",
"project_urls": {
"Homepage": "https://github.com/conda/conda-build"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4c51e343771676ce00e48e74be7e6c1cf27141a0e5039839960c5dac9ac96bb0",
"md5": "76d3ffc4a899255f7daf65d2871edfdb",
"sha256": "edc4cd4d8b12b338268fafbfb93e20d520248cf506940f41a8b08619473b195d"
},
"downloads": -1,
"filename": "conda_build-2.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "76d3ffc4a899255f7daf65d2871edfdb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 235945,
"upload_time": "2017-02-21T19:29:44",
"upload_time_iso_8601": "2017-02-21T19:29:44.648541Z",
"url": "https://files.pythonhosted.org/packages/4c/51/e343771676ce00e48e74be7e6c1cf27141a0e5039839960c5dac9ac96bb0/conda_build-2.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2017-02-21 19:29:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "conda",
"github_project": "conda-build",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "conda-build"
}
JSON
