Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/conda-forge/mashumaro-feedstock

A conda-smithy repository for mashumaro.
https://github.com/conda-forge/mashumaro-feedstock

Last synced: 3 months ago
JSON representation

A conda-smithy repository for mashumaro.

Lists

README 

        
About mashumaro-feedstock

=========================



Feedstock license: [BSD-3-Clause](https://github.com/conda-forge/mashumaro-feedstock/blob/main/LICENSE.txt)



Home: https://github.com/Fatal1ty/mashumaro



Package license: Apache-2.0



Summary: Fast serialization framework on top of dataclasses



Current build status

====================



All platforms:

    

      

        

      

    

  



Current release info

====================



| Name | Downloads | Version | Platforms |

| --- | --- | --- | --- |

| [![Conda Recipe](https://img.shields.io/badge/recipe-mashumaro-green.svg)](https://anaconda.org/conda-forge/mashumaro) | [![Conda Downloads](https://img.shields.io/conda/dn/conda-forge/mashumaro.svg)](https://anaconda.org/conda-forge/mashumaro) | [![Conda Version](https://img.shields.io/conda/vn/conda-forge/mashumaro.svg)](https://anaconda.org/conda-forge/mashumaro) | [![Conda Platforms](https://img.shields.io/conda/pn/conda-forge/mashumaro.svg)](https://anaconda.org/conda-forge/mashumaro) |



Installing mashumaro

====================



Installing `mashumaro` from the `conda-forge` channel can be achieved by adding `conda-forge` to your channels with:



```

conda config --add channels conda-forge

conda config --set channel_priority strict

```



Once the `conda-forge` channel has been enabled, `mashumaro` can be installed with `conda`:



```

conda install mashumaro

```



or with `mamba`:



```

mamba install mashumaro

```



It is possible to list all of the versions of `mashumaro` available on your platform with `conda`:



```

conda search mashumaro --channel conda-forge

```



or with `mamba`:



```

mamba search mashumaro --channel conda-forge

```



Alternatively, `mamba repoquery` may provide more information:



```

# Search all versions available on your platform:

mamba repoquery search mashumaro --channel conda-forge



# List packages depending on `mashumaro`:

mamba repoquery whoneeds mashumaro --channel conda-forge



# List dependencies of `mashumaro`:

mamba repoquery depends mashumaro --channel conda-forge

```



About conda-forge

=================



[![Powered by

NumFOCUS](https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A)](https://numfocus.org)



conda-forge is a community-led conda channel of installable packages.

In order to provide high-quality builds, the process has been automated into the

conda-forge GitHub organization. The conda-forge organization contains one repository

for each of the installable packages. Such a repository is known as a *feedstock*.



A feedstock is made up of a conda recipe (the instructions on what and how to build

the package) and the necessary configurations for automatic building using freely

available continuous integration services. Thanks to the awesome service provided by

[Azure](https://azure.microsoft.com/en-us/services/devops/), [GitHub](https://github.com/),

[CircleCI](https://circleci.com/), [AppVeyor](https://www.appveyor.com/),

[Drone](https://cloud.drone.io/welcome), and [TravisCI](https://travis-ci.com/)

it is possible to build and upload installable packages to the

[conda-forge](https://anaconda.org/conda-forge) [anaconda.org](https://anaconda.org/)

channel for Linux, Windows and OSX respectively.



To manage the continuous integration and simplify feedstock maintenance

[conda-smithy](https://github.com/conda-forge/conda-smithy) has been developed.

Using the ``conda-forge.yml`` within this repository, it is possible to re-render all of

this feedstock's supporting files (e.g. the CI configuration files) with ``conda smithy rerender``.



For more information please check the [conda-forge documentation](https://conda-forge.org/docs/).



Terminology

===========



**feedstock** - the conda recipe (raw material), supporting scripts and CI configuration.



**conda-smithy** - the tool which helps orchestrate the feedstock.

                   Its primary use is in the construction of the CI ``.yml`` files

                   and simplify the management of *many* feedstocks.



**conda-forge** - the place where the feedstock and smithy live and work to

                  produce the finished article (built conda distributions)



Updating mashumaro-feedstock

============================



If you would like to improve the mashumaro recipe or build a new

package version, please fork this repository and submit a PR. Upon submission,

your changes will be run on the appropriate platforms to give the reviewer an

opportunity to confirm that the changes result in a successful build. Once

merged, the recipe will be re-built and uploaded automatically to the

`conda-forge` channel, whereupon the built conda packages will be available for

everybody to install and use from the `conda-forge` channel.

Note that all branches in the conda-forge/mashumaro-feedstock are

immediately built and any created packages are uploaded, so PRs should be based

on branches in forks and branches in the main repository should only be used to

build distinct package versions.



In order to produce a uniquely identifiable distribution:

 * If the version of a package **is not** being increased, please add or increase

   the [``build/number``](https://docs.conda.io/projects/conda-build/en/latest/resources/define-metadata.html#build-number-and-string).

 * If the version of a package **is** being increased, please remember to return

   the [``build/number``](https://docs.conda.io/projects/conda-build/en/latest/resources/define-metadata.html#build-number-and-string)

   back to 0.



Feedstock Maintainers

=====================



* [@maresb](https://github.com/maresb/)

* [@thewchan](https://github.com/thewchan/)