Skip to main content

Setup tools for Lyncs and CMake support

Project description

Setup tools for Lyncs and CMake support

python pypi license build & test codecov pylint black

In this package we provide a wrap around the standard setutools to be used in Lyncs projects.

Installation

The package can be installed via pip:

pip install [--user] lyncs_setuptools

Usage

Lyncs setuptools automizes the deduction of many setup.py options.

Its use in a setup.py file is the following

from lyncs_setuptools import setup

setup(package_name, **kwargs)

where package_name is the name of the package and kwargs are a list of arguments additional or replacement of the one automatically deduced.

NOTE: For seeing the list of the automatically deduced options, run lyncs_setuptools from command line in the directory containing the file setup.py.

NOTE: for correctly installing your package via pip, you need to add a file named pyproject.toml with the following content.

[build-system]
requires = ["lyncs_setuptools", ]

Add "cmake" to the requirements list if you use the following CMake extension.

CMakeExension

Based on https://www.benjack.io/2017/06/12/python-cpp-tests.html we provide a CMakeExtension to support CMake files.

A CMakeExtension can be added as follow

from lyncs_setuptools import setup, CMakeExtension

ext = CMakeExtension(install_dir, source_dir='.', cmake_args=[])

setup(package_name, ext_modules = [ext])

Setup parameters

The following are the parameter used by default in the setup

Automatically deduced:

  • author: (git) author of first commit
  • author_email: (git) email of author of first commit
  • version: (python) value of __version__ defined in __init__.py
  • url: (git) remote address of origin
  • project_urls: (git) defines Source, Documentation, Tracker, Download
  • description: (file) first title of the README
  • long_description: (file) content of the README
  • long_description_content_type: (file) type of README (md/rst)
  • classifiers: (partially)
    • version: Planning (<0.1.0), Pre-Alpha (<0.3.0), Alpha (<0.6.0), Beta (<1.0.0), Production/Stable (<3.0.0), Mature (>=3.0.0)
    • license: TODO
  • keywords: (>3 chars or capital) words in description

Defaulted values

  • classifiers: python 3-only, science

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lyncs_setuptools-0.3.2.tar.gz (14.4 kB view details)

Uploaded Source

File details

Details for the file lyncs_setuptools-0.3.2.tar.gz.

File metadata

  • Download URL: lyncs_setuptools-0.3.2.tar.gz
  • Upload date:
  • Size: 14.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for lyncs_setuptools-0.3.2.tar.gz
Algorithm Hash digest
SHA256 032811f21133d3b92e973bde6fa21725abff229424197147a2aabb96cc6e771e
MD5 ec9b22b5fddd50422bd8d1927011f3b2
BLAKE2b-256 8c61e45dcfa6bf5ec582cbd3172c2a45bceff2ca229b980ea58f586be64375a3

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page