Saravanan666/pypi-org huggingface dataset:
Package: edw.recipe.responsecheck
This recipe can be used to generate a bash script that can test connectivity to application servers.ContentsExample of usageRecipe optionsFinal resultChangelog1.0 - (released)0.9.4-dev - (13.08.2014)0.9.3-dev - (12.08.2014)0.9.2-dev - (12.08.2014)0.9.1-dev - (12.08.2014)0.9-dev - (12.08.2014)Example of usageA simple buildout.cfg:[buildout]
parts = checker

[checker]
recipe = edw.recipe.responsecheck
start-port = 8000
end-port = 9000
step = 2
backends = backend1 ... backend2
path = ${buildout:directory}/binRecipe optionsExplanation:start-port = Port to start the check.
end-port   = Port to end the check.
step       = The numeric value that the count is increased by each loop.
backends   = List of backend names separated by space character.
path       = Path to a folder where the bash script will be saved.Note: All options must be specified.Final resultThis recipe will generate a bash script that for each specified backend will test connectivity
to every port from start-port to end-port with the specified step.Changelog1.0 - (released)Stable version0.9.4-dev - (13.08.2014)Added docs0.9.3-dev - (12.08.2014)Added version.txt0.9.2-dev - (12.08.2014)Fix README0.9.1-dev - (12.08.2014)Fix egg release0.9-dev - (12.08.2014)Verification of a port rangeVerification for multiple backends
Package: edw.seleniumtesting
Selenium based automated testing.InstallationThis package requiresPython 3.5!$ pip install edw.seleniumtesting
$ seleniumtesting -hUsageBy itself this product doesn’t do anything. You must provide test suites to be run in the form of pkg_resource plugins.
Theedw.seleniumtesting.samplesuite is registered in such a way to provide an example.In your own package, after writing the suite (refer toedw.seleniumtesting.sample) you must the following to thesetup.pyof your package (the sample suite is registered in the same way):entry_points={
    'edw.seleniumtesting': [
        'my.package.test1 = my.package.test1:suite',
        'my.package.test2 = my.package.test2:suite',
        'my.package.test3 = my.package.test3:suite',
        [...]
    ]
}andpip install my.package. Modifying the list of tests defined in theentry_pointswill require a
re-installation of your package (re-run pip/setuptools/buildout).To run themy.package.test1,my.package.test2andmy.package.test3tests in Firefox,
specifying the path togeckodriverat the default1024x768resolution:$ seleniumtesting -v -B firefox -P /usr/bin/geckodriver https://localhost my.package.test1 my.package.test2 my.package.test3To run all tests in phantomjs in glorious 4K resolution:$ seleniumtesting -v -B phantomjs -P /usr/bin/phantomjs -sw 3840 -sh 2160 https://localhostFailed tests and tests that encounter an error will save a screenshot in the current working directory.Browser argumentsSupported for Chrome and Firefox. Can be provided using-A. For example, to run Chrome with the--headlessoption:$ seleniumtesting -v -B chrome -P /usr/lib/chromium-browser/chromedriver -A='--headless' https://localhostExtra argumentsSome test suites might make use of extra arguments (e.g. to provide user account credentials).
These can be given using the-eaor--extra-argparameter. For example:seleniumtesting http://localhost ns.some.test -ea labels login "Login Button" -ea users testuser testuserpwdThe arguments will be passed tosuiteas extra_args. Make sure to instantiate yourBrowserTestCasesubclass withextra_argsas well. You will then be able to read the args in the test fromself.extra_args.For the example provided above,self.extra_argswill look like this:{
    'labels': { 'login':    'Login Button' },
    'users':  { 'testuser': 'testuserpwd'  }
}ContributeIssue Tracker:https://github.com/eaudeweb/edw.seleniumtesting/issuesSource Code:https://github.com/eaudeweb/edw.seleniumtestingDocumentation:https://github.com/eaudeweb/edw.seleniumtesting/wikiLicenseThe project is licensed under the GPLv3.ContributorsDavid Bătrânu,b’david.batranu@eaudeweb.ro’Changelog1.1 (2018-04-25)Support for browser options (e.g. –headless)
[david-batranu]1.0 (2017-02-17)Initial release.
[david-batranu]
Package: edw.userhistory
IntroductionEdW User Historypackage will make available a portlet providing user login history.
The portlet will list the most recent 10 user logins. Clicking a userid will open a
page showing the full login history for that user including login date and his/her IP.
A full user listing page is also available in the “Site setup” section of the site.Main featuresNew available portlet called “User login history”Control panel tool to display the full login historyLogin history works not only for local users but for external user sources tooInstallationzc.buildoutIf you are usingzc.buildoutand theplone.recipe.zope2instancerecipe to manage your project, you can do this:Update your buildout.cfg file:Addedw.userhistoryto the list of eggs to installTell the plone.recipe.zope2instance recipe to install a ZCML slug[instance]
...
eggs =
  ...
  edw.userhistory

zcml =
  ...
  edw.userhistoryRe-run buildout, e.g. with:$ ./bin/buildoutYou can skip the ZCML slug if you are going to explicitly include the package
from another package’s configure.zcml file.Copyright and licenseThe Initial Owner of the Original Code is Eau de Wed (EdW).
All Rights Reserved.The EdW User History (the Original Code) is free software;
you can redistribute it and/or modify it under the terms of the GNU
General Public License as published by the Free Software Foundation;
either version 2 of the License, or (at your option) any later
version.More details under edw.userhistory/docs/License.txtChangelog1.8 - (2016-06-23)Bug fix: Use getSite to get portal_membership
[avoinea]1.7 - (2016-05-04)Bug fix: Fix REMOTE_ADDR getter from request.environ
[avoinea]Bug fix: Safely get portal_membership tool
[avoinea]1.6 - (2015-01-09)Change: Added missing package includes in order to be compatible
with Plone >= 4.1
[olimpiurob refs #22037]1.5 - (2012-09-28)Bugfix: fixed version.txt location. Added README.rst
[ghicaale refs #5542]1.4 - (2012-09-28)Feature: added documentation and fixed pylint warning
[ghicaale refs #5542]Feature: enhanced user login history to take into
account all external users, not only the local users
[ghicaale refs #5542]1.3 - (2012-02-22)Bugfix: using proper date format
[david, (Eau de Web)]1.2 - (2012-02-22)Bugfix: proper date sorting
[david, (Eau de Web)]1.1 - (2012-01-06)Bugfix: adding tests
[david, (Eau de Web)]Bugfix: updating package layout for eggmonkey
[david, (Eau de Web)]Bugfix: don’t log user logins if no user information is available in
portal_membership. This solves login issues with Products.PloneSurvey which
uses a separate user folder
[david, (Eau de Web)]1.0 - (2011-08-01)Initial release
[david, (Eau de Web)]
Package: edx-analytics-data-api-client
The edX Analytics API Client (henceforth, client) allows users to retrieve data from the edX data warehouse. Currently,
the client supports retrieving course activity and enrollment data. By default, all data is returned in the JSON format.
Enrollment data may also be retrieved in the CSV format by changing the data_format argument.Testing$ make validateHow to ContributeContributions are very welcome, but for legal reasons, you must submit a signedindividual contributor’s agreementbefore we can accept your contribution. See ourCONTRIBUTINGfile for more information – it also contains guidelines for how to maintain
high code quality, which will make your contribution more likely to be accepted.
Package: edx-analytics-logger
Simple yet powerful OpenEdX plugin to send event tracking logs to a remote
service in order to store additional information about user activity to perform
analytic research.Usage with TutorThis plugin has been tested with OpenEdX Lilac running under Tutor.
For more information about how to add custom requirements to a OpenEdX running
under Tutor see:XBlock and edx-platform plugin developmentOnce the package is added, you can add theApiBackendto your CMS/LMS
settings. To do this, you should override the defaultTRACKING_BACKENDSandEVENT_TRACKING_BACKENDSfromcms/envs/common.pyandlms/evns/common.pysettings files.TRACKING_BACKENDS['api']={'ENGINE':'edx_analytics_logger.api.ApiBackend','OPTIONS':{'http_method':'POST''endpoint':'<FILL_WITH_AN_URI>','headers':{'Content-type':'application/json','Authorization':'Token <FILL_WITH_A_TOKEN>',# ...}}}EVENT_TRACKING_BACKENDS['tracking_logs']['OPTIONS']['backends']['api']={'ENGINE':'edx_analytics_logger.api.ApiBackend','OPTIONS':{'http_method':'POST''endpoint':'<FILL_WITH_AN_URI>','headers':{'Content-type':'application/json','Authorization':'Token <FILL_WITH_A_TOKEN>',# ...}}}This could be accomplished by writing a custom plugin to add these settings in
CMS/LMS settings.Additional notesThis project has been tested using Django REST Framework service as backend.
OpenEdX Analytics Logger could be hugely improved to support more settings,
authentication mechanisms and more options. Feel free to contribute by
reporting bugs, suggesting improvements or opening Pull Requests.
Package: edx-api-doc-tools
edX API Documentation ToolsA toolkit for documenting REST APIs that are created withDRF.The tools usedrf-yasg(DRF, yet another Swagger generator) to generate anOpenAPI Specification, which is a .json/.yaml file that describes your API.
Additionally, this package makes it easy to configure your service to expose
generated OpenAPI specification under/api-docs.yamland to serve interactive
documentation under/api-docs.This library was developed for use withOpen edXservices, but could be used
to document any Django REST Framework API.Quick StartTo start using this tool in your project, seeAdding edx-api-doc-tools to your project.To write docs using this tool, seeWriting API documentation.DocumentationComphrehensive documentation is coming soon.  For now, check out theexample/directory, which shows a fake API using these tools to generate documentation.LicenseThe code in this repository is licensed under the Apache Software License 2.0
unless otherwise noted.Please seeLICENSE.txtfor details.How To ContributeContributions are very welcome.  Please readHow To Contributefor details.
Even though they were written withedx-platformin mind, the guidelines
should be followed for all Open edX projects.The pull request description template should be automatically applied if you
are creating a pull request from GitHub. Otherwise you can find it atPULL_REQUEST_TEMPLATE.md.The issue report template should be automatically applied if you are creating
an issue on GitHub as well. Otherwise you can find it atISSUE_TEMPLATE.md.Reporting Security IssuesPlease do not report security issues in public. Please emailsecurity@edx.org.Getting HelpHave a question about this repository, or about the Open edX project in general?  Please refer to thislist of resourcesif you need any assistance.Change LogUnreleased1.7.0 — 2023-07-23Switch fromedx-sphinx-themetosphinx-book-themesince the former is
deprecatedAdd support for Django 4.21.6.0 — 2022-02-11Dropped support for django 2.2, 3.0, 3.1Added support for Django 4.01.5.0 — 2021-07-19Added support for django 3.0, 3.1 and 3.21.4.3 — 2021-07-15Removed Django constraints from base.in1.4.2 — 2021-01-08Dropped python3.5 support.1.4.1 — 2020-11-20Updated the travis-badge in README.rst to point to travis-ci.com1.4.0 — 2020-10-05Adding option to include a body parameter in requests.1.3.2 — 2020-09-23Adding option to specify url patterns for generated docs.1.3.1 — 2020-05-29Removing caniusepython3 as it is no longer needed since python3 upgrade.1.3.0 — 2020-04-30Remove support for Django<2.2 and add support for python 3.81.2.0 — 2020-03-20Added three new decorators for excluding endpoints from API documentation generation:@exclude_schema@exclude_schema_for(method_name)@exclude_all_schemas1.1.0 — 2020-03-20Compatibility with Django 2.1 and 2.2.1.0.3 — 2020-01-31Added documentation.1.0.2 — 2020-01-17First release on PyPI.
Package: edxbackup
edxbackup is database backup program designed to work withopenedxdata sources, but not specific to it.edxbackup is a wrapper aroundrestic.installationmanualMake sure that you have following software installed in your environment:Python 3.11resticmyloadermongodb-toolsThen, runpip installedxbackup==3.1.1.dockerdocker pull edxbackup:3.1.1runningpreparationsYou need restic repository set up elsewhere for edxbackup to operate. Consultrestic docsto do it.Before running edxbackup make sure thatRESTIC_REPOSITORYandRESTIC_PASSWORDare set.configYou can useexample/edxbackup.jsonin repo as a reference. All the sections
are mandatory, but you can setmysql,mongoands3to empty list if
you don’t want to backup those.There’s two ways to pass config location to edxbackup:Put it in theEDXBACKUP_CONFIG_PATHenvironment variablePass it as the value of-cor--configcommand line flagIf neither is used, edxbackup will /etc/edxbackup.json as fallback.backupRunedxbackup backup. The last line in it’s output will be backup ID.list & showedxbackup listandedxbackup showare informational commands. You can
use the first one to show a list of available backups and the second one to
inspect individual backup contents.restoreRunedxbackup restore <BACKUP_ID>. Make sure to replace<BACKUP_ID>with your backup ID.running regularilyThere’s example systemd service & timer in systemd/ directory.deleting old backupsThere’scontrib/delete_old.pyscript in this repo that will runrestic forgetcommand with arguments adjustable by environment variables.Make sure that
you read the script before running it. It is destructive.
Package: edx-braze-client
Python client for interacting with Braze APIs.Development WorkflowOne Time Setup# Clone the repository
git clone git@github.com:edx/braze-client.git
cd braze-client

# Set up a virtualenv using virtualenvwrapper with the same name as the repo and activate it
mkvirtualenv -p python3.8 braze-client
or
virtualenv --python=python3 <venv>Every time you develop something in this repo# Activate the virtualenv
workon braze-client
or
source <venv>/bin/activate

# Grab the latest code
git checkout main
git pull

# Install/update the dev requirements
make requirements

# Run the tests and quality checks (to verify the status before you make any changes)
make validate

# Make a new branch for your changes
git checkout -b <your_github_username>/<short_description>

# Using your favorite editor, edit the code to make your change.
vim …

# Run your new tests
pytest ./path/to/new/tests

# Run all the tests and quality checks
make validate

# Commit all your changes
git commit …
git push

# Open a PR and ask for review.LicenseThe code in this repository is licensed under the AGPL 3.0 unless
otherwise noted.Please seeLICENSE.txtfor details.How To ContributeContributions are very welcome.
Please readHow To Contributefor details.
Even though they were written withedx-platformin mind, the guidelines
should be followed for all Open edX projects.The pull request description template should be automatically applied if you are creating a pull request from GitHub. Otherwise you
can find it atPULL_REQUEST_TEMPLATE.md.The issue report template should be automatically applied if you are creating an issue on GitHub as well. Otherwise you
can find it atISSUE_TEMPLATE.md.Reporting Security IssuesPlease do not report security issues in public. Please emailsecurity@edx.org.Getting HelpIf you’re having trouble, we have discussion forums athttps://discuss.openedx.orgwhere you can connect with others in the community.Our real-time conversations are on Slack. You can request aSlack invitation, then join ourcommunity Slack workspace.For more information about these options, see theGetting Helppage.Change LogUnreleased[0.2.2]fix: be defensive about pulling bothemailandexternal_idfrom braze export.[0.2.1]fix: be defensive about pulling external_id from braze export.[0.2.0]feat: check for external ids in batchs when creating aliases.[0.1.8]fix: always create an alias for existing profiles[0.1.7]feat: add retrieve_unsubscribed_emails method[0.1.6]feat: add unsubscribe_user_email method[0.1.5]feat: add send_canvas_message method[0.1.4]feat: add identify_users method[0.1.3]fix: handle intermittent JSONDecodeError from from Braze[0.1.2]feat: add override_frequency_capping arg for send_email[0.1.1]feat: advertise constraints in setup.py[0.1.0] - 2021-10-20AddedFirst release on PyPI.
Package: edx-celeryutils
Code to support working with Celery, a distributed task queue.Overview (please modify)This package contains utilities to wrap tasks with logging and to
persist them if they fail.It also supports Django administration for searching and deleting
failed tasks, and management commands for rerunning failed tasks and
deleting old ones.Documentation(TODO:Set up documentation)Publishing a ReleaseAfter a PR merges, a new version of the package will automatically be released by Travis when the commit is tagged. Use:git tag -a X.Y.Z -m "Releasing version X.Y.Z"
git push origin X.Y.ZDonotcreate a Github Release, or ensure its message points to the CHANGELOG.rst.LicenseThe code in this repository is licensed under the Apache 2.0 unless
otherwise noted.Please seeLICENSE.txtfor details.How To ContributeContributions are very welcome.Please readHow To Contributefor details.Reporting Security IssuesPlease do not report security issues in public. Please emailsecurity@openedx.org.Getting HelpHave a question about this repository, or about Open edX in general?  Please
refer to thislist of resourcesif you need any assistance.Change LogUnreleased[1.2.5] - 2024-02-01Ran django-upgrade tool to add support for Django 4.2 in missing files.[1.2.3] - 2023-06-15Support added for Django 4.2.Switch fromedx-sphinx-themetosphinx-book-themesince the former is
deprecated[1.2.2] - 2022-01-24Removed future package dependency.[1.2.1] - 2022-01-24Updated celery constraint to <6.0 to fix make upgrade failure in edx-platform[1.2.0] - 2022-01-19Removed Django22, 30, 31 supportAdded Support for Django40[1.1.1] - 2021-08-24Replacing jsonfield2 with jsonfield as the former is merged back into the latter one.[1.1.0] - 2021-07-07Added support for django 3.1 and 3.2[1.0.0] - 2021-01-21Dropped python3.5 support.[0.5.4] - 2020-12-10Upgrade celery to 5.0.4[0.5.3] - 2020-09-15Move to Apache 2.0 license[0.5.2] - 2020-08-28Upgrade celery to 4.2.2[0.5.1] - 2020-06-30Added python38 support.[0.5.0] - 2020-04-01No functional change.[0.4.0] - 2020-03-05Removed all references to django-celery and removed it as a dependency.Removed ChordableDjangoBackend and ChordData.[0.2.7] - 2017-12-04Add logging for non-retried failed tasks.[0.2.6] - 2017-08-07Upgrade version of django-celery.[0.2.5] - 2017-08-03Django 1.11 compatibility[0.2.4] - 2017-06-20Add management command to fix djcelery tables.[0.2.1] - 2017-05-22Add ChordableDjangoBackend and testing.[0.1.3] - 2017-03-01Packaging changes.[0.1.1] - 2017-02-22Added django admin for management of FailedTasks.[0.1.0] - 2017-01-31Initial releaseContains two task base classes:LoggedTask - Reports extra logging info 1) when a task is submitted to the task service (for tracking task latency) and 2) when the task retries, it surfaces information about the raised exception.PersistOnFailureTask - Stores a record of failed tasks that can later be retried.
Package: edx-django-oauth2-provider
django-oauth2-providerThis is an edX-customized fork ofdjango-oauth2-provider, a Django application that provides
customizable OAuth2-authentication for your Django projects.DocumentationHelpRelease Notes1.3.5Add support for Django 2.0 and Python 3.7Drop support for Django < 1.111.3.4Have the delete management commands only scan from the smallest expired token
to the max expired token.While deleting, only examine chunk_size rows for expired rows to delete.Fix warnings about using a datetime without a timezone in the delete
management command.1.3.3Have delete management commands handle 0 tokens to delete casesStop testing on Django < 1.111.3.2Fixed a compatibility issue with migrations and Python 31.3.1Added support for storing settings.SECRET_KEY as bytes.Added python_2_unicode_compatible decorator to models.1.3.0Added Python 3 support.1.2.5Added management command to delete expired OAuth2 access and refresh tokens.1.2.4More management command MySQL compatibility updates.1.2.3Update management command to be MySQL 5.6 compatible, use ORM for deletions.1.2.2Add management command to delete expired OAuth2 grant tokens.1.2.1Add Django 1.10/1.11 support.1.2.0Add ‘nonce’ to OAuth2 grant tokens model.1.0.2This release contains a backward incompatible change:Foreign key reverse names have been specified, so this library can be
installed alongsidedjango-oauth-toolkit.  Code that traverses from
the User model todjango-oauth2-providermodels will need to update the
related name used.>>> user.access_token
>>> user.grant
>>> user.refresh_tokenbecomes:>>> user.dop_access_token
>>> user.dop_grant
>>> user.dop_refresh_tokenLicensedjango-oauth2-provideris released under the MIT License. Please see the LICENSE file for details.
Package: edx-django-release-util
Part ofedX code.edX Django Release UtilitiesRelease pipeline utilities for edX independently-deployable applications (IDAs) based on Django.UsageInstall this package via pip:pip install edx-django-release-util.Update your project settings, adding‘release_util’toINSTALLED_APPS.TestingInstall the requirements:make requirementsRun the tests:make testLicenseThe code in this repository is licensed under AGPL unless otherwise noted.Please seeLICENSE.txtfor details.How To ContributeContributions are very welcome.Please readHow To Contributefor details.Reporting Security IssuesPlease do not report security issues in public. Please emailsecurity@edx.org.Mailing List and IRC ChannelYou can discuss this code in theedx-code Google Groupor in the#edx-codeIRC channel on Freenode.