Skip to content

Commit

Permalink
restructured for packaging with poetry
Browse files Browse the repository at this point in the history
  • Loading branch information
skunklem committed Mar 1, 2023
1 parent d70d3ce commit 4e6b01d
Show file tree
Hide file tree
Showing 10 changed files with 327 additions and 0 deletions.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
169 changes: 169 additions & 0 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

25 changes: 25 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
[tool.poetry]
name = "ncbi-submit"
version = "0.1.0"
description = "A tool for submitting to NCBI (SRA, BioSample, & GenBank)."
license = "MIT"
authors = [
"Sam Kunkleman <[email protected]>",
]
maintainers = [
"Sam Kunkleman <[email protected]>",
]
repository = "https://github.com/enviro-lab/ncbi_interact"
keywords = ["ncbi", "submission","upload"]
readme = "README.md"
packages = [
{ include = "ncbi_submit" },
]

[tool.poetry.dependencies]
python = ">=3.8"
pandas = "^1.5.3"
biopython = "^1.81"

[tool.poetry.scripts]
ncbi_submit = 'ncbi_submit.ncbi_submit:main'
133 changes: 133 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-

# NOTE: code adapted from https://github.com/navdeep-G/setup.py/blob/master/setup.py

# Note: To use the 'upload' functionality of this file, you must:
# $ pipenv install twine --dev

import io
import os
import sys
from shutil import rmtree
from setuptools import find_packages, setup, Command

# Package meta-data.
NAME = 'ncbi-submit'
DESCRIPTION = 'A tool for submitting to NCBI (SRA, BioSample, & GenBank).'
URL = 'https://github.com/enviro-lab/ncbi_interact'
EMAIL = '[email protected]'
AUTHOR = 'Sam Kunkleman'
REQUIRES_PYTHON = '>=3.6.0'
VERSION = ''

# What packages are required for this module to be executed?
REQUIRED = [
'biopython',
'pandas',
]

# What packages are optional?
EXTRAS = {
# 'fancy feature': ['django'],
}

# The rest you shouldn't have to touch too much :)
# ------------------------------------------------
# Except, perhaps the License and Trove Classifiers!
# If you do change the License, remember to change the Trove Classifier for that!

here = os.path.abspath(os.path.dirname(__file__))

# Import the README and use it as the long-description.
# Note: this will only work if 'README.md' is present in your MANIFEST.in file!
try:
with io.open(os.path.join(here, 'README.md'), encoding='utf-8') as f:
long_description = '\n' + f.read()
except FileNotFoundError:
long_description = DESCRIPTION

# Load the package's __version__.py module as a dictionary.
about = {}
if not VERSION:
project_slug = NAME.lower().replace("-", "_").replace(" ", "_")
with open(os.path.join(here, project_slug, '__version__.py')) as f:
exec(f.read(), about)
else:
about['__version__'] = VERSION


class UploadCommand(Command):
"""Support setup.py upload."""

description = 'Build and publish the package.'
user_options = []

@staticmethod
def status(s):
"""Prints things in bold."""
print('\033[1m{0}\033[0m'.format(s))

def initialize_options(self):
pass

def finalize_options(self):
pass

def run(self):
try:
self.status('Removing previous builds…')
rmtree(os.path.join(here, 'dist'))
except OSError:
pass

self.status('Building Source and Wheel (universal) distribution…')
os.system('{0} setup.py sdist bdist_wheel --universal'.format(sys.executable))

self.status('Uploading the package to PyPI via Twine…')
os.system('twine upload dist/*')

self.status('Pushing git tags…')
os.system('git tag v{0}'.format(about['__version__']))
os.system('git push --tags')

sys.exit()


# Where the magic happens:
setup(
name=NAME,
version=about['__version__'],
description=DESCRIPTION,
long_description=long_description,
long_description_content_type='text/markdown',
author=AUTHOR,
author_email=EMAIL,
python_requires=REQUIRES_PYTHON,
url=URL,
# packages=find_packages(exclude=["tests", "*.tests", "*.tests.*", "tests.*"]),
# If your package is a single module, use this instead of 'packages':
py_modules=['ncbi_submit'],

# entry_points={
# 'console_scripts': ['mycli=mymodule:cli'],
# },
install_requires=REQUIRED,
extras_require=EXTRAS,
include_package_data=True,
license='MIT',
classifiers=[
# Trove classifiers
# Full list: https://pypi.python.org/pypi?%3Aaction=list_classifiers
'License :: OSI Approved :: MIT License',
'Programming Language :: Python',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.6',
'Programming Language :: Python :: Implementation :: CPython',
'Programming Language :: Python :: Implementation :: PyPy'
],
# # $ setup.py publish support.
# cmdclass={
# 'upload': UploadCommand,
# },
)

0 comments on commit 4e6b01d

Please sign in to comment.